]> git.ipfire.org Git - thirdparty/mdadm.git/blame - mdadm.h
util: split get_maj_min() out from dev_open()
[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>
0d35d5c4 28#ifdef __GLIBC__
64c4757e 29extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
0d35d5c4 30#elif !defined(lseek64)
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 54#include <linux/kdev_t.h>
e0d19036
NB
55/*#include <linux/fs.h> */
56#include <sys/mount.h>
57#include <asm/types.h>
64c4757e
NB
58#include <sys/ioctl.h>
59#define MD_MAJOR 9
dd0781e5 60#define MdpMinorShift 6
64c4757e 61
e0d19036 62#ifndef BLKGETSIZE64
98c6faba 63#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
e0d19036 64#endif
56eb10c0 65
c21e737b 66#define DEFAULT_CHUNK 512
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.
96fd06ed 73 * /run seems to have emerged as the best standard.
5d4d1b26 74 */
753cf905 75#ifndef MAP_DIR
96fd06ed 76#define MAP_DIR "/run/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
96fd06ed 85 * with mdmon normally live. Best is /var/run/mdadm as
753cf905
DL
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
96fd06ed 93#define MDMON_DIR "/run/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
96fd06ed 101#define FAILED_SLOTS_DIR "/run/mdadm/failed-slots"
403410eb
PC
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 131#if BYTE_ORDER == LITTLE_ENDIAN
8a5f247d
JS
132#define __cpu_to_le16(_x) (unsigned int)(_x)
133#define __cpu_to_le32(_x) (unsigned int)(_x)
134#define __cpu_to_le64(_x) (unsigned long long)(_x)
135#define __le16_to_cpu(_x) (unsigned int)(_x)
136#define __le32_to_cpu(_x) (unsigned int)(_x)
137#define __le64_to_cpu(_x) (unsigned long long)(_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 152
8a5f247d
JS
153#define __cpu_to_be16(_x) (unsigned int)(_x)
154#define __cpu_to_be32(_x) (unsigned int)(_x)
155#define __cpu_to_be64(_x) (unsigned long long)(_x)
156#define __be16_to_cpu(_x) (unsigned int)(_x)
157#define __be32_to_cpu(_x) (unsigned int)(_x)
158#define __be64_to_cpu(_x) (unsigned long long)(_x)
1e0d770c
NB
159#else
160# error "unknown endianness."
161#endif
e39b673e 162#endif /* __KLIBC__ */
1e0d770c 163
1e5c6983
DW
164/*
165 * min()/max()/clamp() macros that also do
166 * strict type-checking.. See the
167 * "unnecessary" pointer comparison.
168 */
169#define min(x, y) ({ \
170 typeof(x) _min1 = (x); \
171 typeof(y) _min2 = (y); \
172 (void) (&_min1 == &_min2); \
173 _min1 < _min2 ? _min1 : _min2; })
174
175#define max(x, y) ({ \
176 typeof(x) _max1 = (x); \
177 typeof(y) _max2 = (y); \
178 (void) (&_max1 == &_max2); \
179 _max1 > _max2 ? _max1 : _max2; })
1e0d770c 180
1c0aebc2
N
181#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
182
4b1ac34b
NB
183/* general information that might be extracted from a superblock */
184struct mdinfo {
185 mdu_array_info_t array;
186 mdu_disk_info_t disk;
187 __u64 events;
fbf8a0b7 188 int uuid[4];
31317663 189 char name[33];
353632d9 190 unsigned long long data_offset;
fe384ca0 191 unsigned long long new_data_offset;
598f0d58
NB
192 unsigned long long component_size; /* same as array.size, except in
193 * sectors and up to 64bits.
194 */
da9b4a62
DW
195 unsigned long long custom_array_size; /* size for non-default sized
196 * arrays (in sectors)
197 */
81219e70
LM
198#define NO_RESHAPE 0
199#define VOLUME_RESHAPE 1
200#define CONTAINER_RESHAPE 2
5e88ab2e 201#define RESHAPE_NO_BACKUP 16 /* Mask 'or'ed in */
353632d9
NB
202 int reshape_active;
203 unsigned long long reshape_progress;
6e75048b
AK
204 int recovery_blocked; /* for external metadata it
205 * indicates that there is
206 * reshape in progress in
207 * container,
208 * for native metadata it is
209 * reshape_active field mirror
210 */
80bf9135
N
211 /* During reshape we can sometimes change the data_offset to avoid
212 * over-writing still-valid data. We need to know if there is space.
213 * So getinfo_super will fill in space_before and space_after in sectors.
214 * data_offset can be increased or decreased by this amount.
215 */
216 unsigned long long space_before, space_after;
e1516be1
DW
217 union {
218 unsigned long long resync_start; /* per-array resync position */
219 unsigned long long recovery_start; /* per-device rebuild position */
b7528a20 220 #define MaxSector (~0ULL) /* resync/recovery complete position */
e1516be1 221 };
fbdef498 222 long bitmap_offset; /* 0 == none, 1 == a file */
a67dd8cc 223 unsigned long safe_mode_delay; /* ms delay to mark clean */
353632d9 224 int new_level, delta_disks, new_layout, new_chunk;
06c7f68e 225 int errors;
f21e18ca 226 unsigned long cache_size; /* size of raid456 stripe cache*/
7e0f6979
NB
227 int mismatch_cnt;
228 char text_version[50];
dd15dc4a
NB
229
230 int container_member; /* for assembling external-metatdata arrays
231 * This is to be used internally by metadata
232 * handler only */
97b4d0e9
DW
233 int container_enough; /* flag external handlers can set to
234 * indicate that subarrays have not enough (-1),
235 * enough to start (0), or all expected disks (1) */
1011e834 236 char sys_name[20];
7e0f6979 237 struct mdinfo *devs;
06c7f68e 238 struct mdinfo *next;
549e9569
NB
239
240 /* Device info for mdmon: */
e1516be1 241 int recovery_fd;
549e9569 242 int state_fd;
8d45d196
DW
243 #define DS_FAULTY 1
244 #define DS_INSYNC 2
245 #define DS_WRITE_MOSTLY 4
246 #define DS_SPARE 8
247 #define DS_BLOCKED 16
248 #define DS_REMOVE 1024
92967543 249 #define DS_UNBLOCK 2048
549e9569
NB
250 int prev_state, curr_state, next_state;
251
4b1ac34b
NB
252};
253
5bbb4842
NB
254struct createinfo {
255 int uid;
256 int gid;
257 int autof;
258 int mode;
38098016 259 int symlinks;
eca944fa 260 int names;
e2efe9e7 261 int bblist;
058574b1 262 struct supertype *supertype;
5bbb4842
NB
263};
264
9a9dab36 265#define Name "mdadm"
682c7051 266
e0d19036
NB
267enum mode {
268 ASSEMBLE=1,
269 BUILD,
270 CREATE,
271 MANAGE,
272 MISC,
273 MONITOR,
dd0781e5 274 GROW,
8382f19b 275 INCREMENTAL,
1f48664b 276 AUTODETECT,
5187a385 277 mode_count
e0d19036
NB
278};
279
64c4757e 280extern char short_options[];
024768c4 281extern char short_bitmap_options[];
c06487ce 282extern char short_bitmap_auto_options[];
64c4757e 283extern struct option long_options[];
56eedc1a 284extern char Version[], Usage[], Help[], OptionHelp[],
5187a385 285 *mode_help[],
dd0781e5 286 Help_create[], Help_build[], Help_assemble[], Help_grow[],
8382f19b 287 Help_incr[],
e0d19036 288 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e 289
997aed5d 290/* for option that don't have short equivilents, we assign arbitrary
1c7a808c 291 * numbers later than any 'short' character option.
997aed5d
NB
292 */
293enum special_options {
1c7a808c 294 AssumeClean = 300,
997aed5d
NB
295 BitmapChunk,
296 WriteBehind,
297 ReAdd,
298 NoDegraded,
299 Sparc22,
1c7a808c 300 BackupFile,
997aed5d 301 HomeHost,
589395d6 302 AutoHomeHost,
38098016 303 Symlinks,
1f48664b 304 AutoDetect,
1770662b 305 Waitclean,
4cce4069 306 DetailPlatform,
33414a01 307 KillSubarray,
1c7a808c 308 UpdateSubarray,
edde9560 309 IncrementalPath,
1c7a808c
N
310 NoSharing,
311 HelpOptions,
312 Brief,
313 ManageOpt,
314 Add,
f33a71f1 315 AddSpare,
1c7a808c
N
316 Remove,
317 Fail,
70c55e36
N
318 Replace,
319 With,
1c7a808c
N
320 MiscOpt,
321 WaitOpt,
322 ConfigFile,
323 ChunkSize,
324 WriteMostly,
325 Layout,
326 Auto,
327 Force,
328 SuperMinor,
329 EMail,
330 ProgramOpt,
331 Increment,
332 Fork,
333 Bitmap,
334 RebuildMapOpt,
87f26d14 335 InvalidBackup,
20b60dcd 336 UdevRules,
b76b30e0 337 FreezeReshape,
2dddadb0 338 Continue,
08ca2adf 339 OffRootOpt,
c2ecf5f6 340 Prefer,
f7d3febc 341 KillOpt,
40c9a66a 342 DataOffset,
6d388a88 343 ExamineBB,
74db60b0
N
344 Dump,
345 Restore,
a740cf64 346 Action,
997aed5d
NB
347};
348
f0ec6710
MN
349enum prefix_standard {
350 JEDEC,
351 IEC
352};
353
64c4757e 354/* structures read from config file */
52826846
NB
355/* List of mddevice names and identifiers
356 * Identifiers can be:
357 * uuid=128-hex-uuid
358 * super-minor=decimal-minor-number-from-superblock
359 * devices=comma,separated,list,of,device,names,with,wildcards
360 *
361 * If multiple fields are present, the intersection of all matching
362 * devices is considered
363 */
98c6faba 364#define UnSet (0xfffe)
fa56eddb 365struct mddev_ident {
dd0781e5 366 char *devname;
aba69144 367
dd0781e5 368 int uuid_set;
3fa06e9d 369 int uuid[4];
947fd4dd 370 char name[33];
52826846 371
f21e18ca 372 int super_minor;
52826846 373
dd0781e5 374 char *devices; /* comma separated list of device
52826846
NB
375 * names with wild cards
376 */
dd0781e5 377 int level;
f21e18ca
N
378 int raid_disks;
379 int spare_disks;
82d9eba6 380 struct supertype *st;
dd0781e5
NB
381 int autof; /* 1 for normal, 2 for partitioned */
382 char *spare_group;
7ef02d01 383 char *bitmap_file;
c82f047c 384 int bitmap_fd;
dd0781e5 385
1771a6e2
N
386 char *container; /* /dev/whatever name of container, or
387 * uuid of container. You would expect
388 * this to be the 'devname' or UUID
dbb44303
N
389 * of some other entry.
390 */
391 char *member; /* subarray within a container */
392
fa56eddb 393 struct mddev_ident *next;
b179246f
N
394 union {
395 /* fields needed by different users of this structure */
396 int assembled; /* set when assembly succeeds */
397 };
fa56eddb 398};
64c4757e 399
9e33d556
N
400struct context {
401 int readonly;
402 int runstop;
403 int verbose;
9e33d556
N
404 int brief;
405 int force;
406 char *homehost;
407 int require_homehost;
408 char *prefer;
409 int export;
410 int test;
411 char *subarray;
412 char *update;
413 int scan;
414 int SparcAdjust;
415 int autof;
416 int delay;
417 int freeze_reshape;
418 char *backup_file;
419 int invalid_backup;
a740cf64 420 char *action;
9e33d556
N
421};
422
e705e81b
N
423struct shape {
424 int raiddisks;
425 int sparedisks;
426 int level;
427 int layout;
428 char *layout_str;
429 int chunk;
430 int bitmap_chunk;
431 char *bitmap_file;
432 int assume_clean;
433 int write_behind;
434 unsigned long long size;
435};
436
64c4757e 437/* List of device names - wildcards expanded */
a655e550 438struct mddev_dev {
64c4757e 439 char *devname;
c8e1a230
N
440 int disposition; /* 'a' for add, 'r' for remove, 'f' for fail,
441 * 'A' for re_add.
cd29a5c8
NB
442 * Not set for names read from .config
443 */
b3d31955 444 char writemostly; /* 1 for 'set writemostly', 2 for 'clear writemostly' */
70c55e36 445 int used; /* set when used */
72ca9bcf 446 long long data_offset;
a655e550
N
447 struct mddev_dev *next;
448};
64c4757e 449
682c7051
NB
450typedef struct mapping {
451 char *name;
452 int num;
453} mapping_t;
454
e0d19036
NB
455struct mdstat_ent {
456 char *dev;
4dd2df09 457 char devnm[32];
e0d19036
NB
458 int active;
459 char *level;
460 char *pattern; /* U or up, _ for down */
461 int percent; /* -1 if no resync */
f94c116f 462 int resync; /* 3 if check, 2 if reshape, 1 if resync, 0 if recovery */
549e9569
NB
463 int devcnt;
464 int raid_disks;
549e9569 465 char * metadata_version;
3b57c466
N
466 struct dev_member {
467 char *name;
468 struct dev_member *next;
1011e834 469 } *members;
e0d19036
NB
470 struct mdstat_ent *next;
471};
472
22a88995 473extern struct mdstat_ent *mdstat_read(int hold, int start);
a7a0d8a1 474extern void mdstat_close(void);
e0d19036 475extern void free_mdstat(struct mdstat_ent *ms);
dd0781e5 476extern void mdstat_wait(int seconds);
58a4ba2a 477extern void mdstat_wait_fd(int fd, const sigset_t *sigmask);
4dd2df09 478extern int mddev_busy(char *devnm);
3b57c466 479extern struct mdstat_ent *mdstat_by_component(char *name);
4dd2df09 480extern struct mdstat_ent *mdstat_by_subdev(char *subdev, char *container);
8382f19b
NB
481
482struct map_ent {
483 struct map_ent *next;
4dd2df09 484 char devnm[32];
1522c538 485 char metadata[20];
8382f19b 486 int uuid[4];
195254b8 487 int bad;
8382f19b
NB
488 char *path;
489};
4dd2df09 490extern int map_update(struct map_ent **mpp, char *devnm, char *metadata,
8382f19b 491 int uuid[4], char *path);
4dd2df09 492extern void map_remove(struct map_ent **map, char *devnm);
8382f19b 493extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
eb2306f8
N
494#ifdef MDASSEMBLE
495static inline struct map_ent *map_by_devnm(struct map_ent **map, char *name)
496{
497 return NULL;
498}
499static inline void map_free(struct map_ent *map)
500{
501}
502#else
4dd2df09 503extern struct map_ent *map_by_devnm(struct map_ent **map, char *devnm);
eb2306f8
N
504extern void map_free(struct map_ent *map);
505#endif
f2e55ecc 506extern struct map_ent *map_by_name(struct map_ent **map, char *name);
8382f19b
NB
507extern void map_read(struct map_ent **melp);
508extern int map_write(struct map_ent *mel);
4dd2df09 509extern void map_delete(struct map_ent **mapp, char *devnm);
8382f19b 510extern void map_add(struct map_ent **melp,
4dd2df09 511 char *devnm, char *metadata, int uuid[4], char *path);
ad5bc697
N
512extern int map_lock(struct map_ent **melp);
513extern void map_unlock(struct map_ent **melp);
cc700db3 514extern void map_fork(void);
e0d19036 515
e86c9dd6 516/* various details can be requested */
dab4a513
DW
517enum sysfs_read_flags {
518 GET_LEVEL = (1 << 0),
519 GET_LAYOUT = (1 << 1),
520 GET_COMPONENT = (1 << 2),
521 GET_CHUNK = (1 << 3),
522 GET_CACHE = (1 << 4),
523 GET_MISMATCH = (1 << 5),
524 GET_VERSION = (1 << 6),
525 GET_DISKS = (1 << 7),
526 GET_DEGRADED = (1 << 8),
527 GET_SAFEMODE = (1 << 9),
c0c1acd6
N
528 GET_BITMAP_LOCATION = (1 << 10),
529
530 GET_DEVS = (1 << 20), /* gets role, major, minor */
531 GET_OFFSET = (1 << 21),
532 GET_SIZE = (1 << 22),
533 GET_STATE = (1 << 23),
534 GET_ERROR = (1 << 24),
dab4a513 535};
e86c9dd6
NB
536
537/* If fd >= 0, get the array it is open on,
4dd2df09 538 * else use devnm.
e86c9dd6 539 */
4dd2df09
N
540extern int sysfs_open(char *devnm, char *devname, char *attr);
541extern void sysfs_init(struct mdinfo *mdi, int fd, char *devnm);
7e0f6979 542extern void sysfs_free(struct mdinfo *sra);
4dd2df09 543extern struct mdinfo *sysfs_read(int fd, char *devnm, unsigned long options);
1770662b
DW
544extern int sysfs_attr_match(const char *attr, const char *str);
545extern int sysfs_match_word(const char *word, char **list);
7e0f6979 546extern int sysfs_set_str(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 547 char *name, char *val);
7e0f6979 548extern int sysfs_set_num(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 549 char *name, unsigned long long val);
012a8641
JS
550extern int sysfs_set_num_signed(struct mdinfo *sra, struct mdinfo *dev,
551 char *name, long long val);
97590376 552extern int sysfs_uevent(struct mdinfo *sra, char *event);
7236ee7a
N
553extern int sysfs_get_fd(struct mdinfo *sra, struct mdinfo *dev,
554 char *name);
555extern int sysfs_fd_get_ll(int fd, unsigned long long *val);
7e0f6979 556extern int sysfs_get_ll(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 557 char *name, unsigned long long *val);
2eba8496
N
558extern int sysfs_fd_get_two(int fd, unsigned long long *v1, unsigned long long *v2);
559extern int sysfs_get_two(struct mdinfo *sra, struct mdinfo *dev,
560 char *name, unsigned long long *v1, unsigned long long *v2);
7236ee7a 561extern int sysfs_fd_get_str(int fd, char *val, int size);
bc77ed53
DW
562extern int sysfs_attribute_available(struct mdinfo *sra, struct mdinfo *dev,
563 char *name);
93ecfa01
N
564extern int sysfs_get_str(struct mdinfo *sra, struct mdinfo *dev,
565 char *name, char *val, int size);
8ed3e5e1 566extern int sysfs_set_safemode(struct mdinfo *sra, unsigned long ms);
f35f2525 567extern int sysfs_set_array(struct mdinfo *info, int vers);
2904b26f 568extern int sysfs_add_disk(struct mdinfo *sra, struct mdinfo *sd, int resume);
f1665f72 569extern int sysfs_disk_to_scsi_id(int fd, __u32 *id);
4dd2df09 570extern int sysfs_unique_holder(char *devnm, long rdev);
bc77ed53 571extern int sysfs_freeze_array(struct mdinfo *sra);
efc67e8e 572extern int sysfs_wait(int fd, int *msec);
c69b251b 573extern int load_sys(char *path, char *buf);
130994cb
AK
574extern int reshape_prepare_fdlist(char *devname,
575 struct mdinfo *sra,
576 int raid_disks,
577 int nrdisks,
578 unsigned long blocks,
579 char *backup_file,
580 int *fdlist,
581 unsigned long long *offsets);
582extern void reshape_free_fdlist(int *fdlist,
583 unsigned long long *offsets,
584 int size);
e6e9d47b
AK
585extern int reshape_open_backup_file(char *backup,
586 int fd,
587 char *devname,
588 long blocks,
589 int *fdlist,
a93f87ee 590 unsigned long long *offsets,
54ded86f 591 char *sysfs_name,
a93f87ee 592 int restart);
1c009fc2
AK
593extern unsigned long compute_backup_blocks(int nchunk, int ochunk,
594 unsigned int ndata, unsigned int odata);
54ded86f
N
595extern char *locate_backup(char *name);
596extern char *make_backup(char *name);
e86c9dd6
NB
597
598extern int save_stripes(int *source, unsigned long long *offsets,
599 int raid_disks, int chunk_size, int level, int layout,
600 int nwrites, int *dest,
a6288483
N
601 unsigned long long start, unsigned long long length,
602 char *buf);
353632d9
NB
603extern int restore_stripes(int *dest, unsigned long long *offsets,
604 int raid_disks, int chunk_size, int level, int layout,
605 int source, unsigned long long read_offset,
2fcb75ae
AK
606 unsigned long long start, unsigned long long length,
607 char *src_buf);
e86c9dd6 608
52826846
NB
609#ifndef Sendmail
610#define Sendmail "/usr/lib/sendmail -t"
611#endif
612
773135f5
NB
613#define SYSLOG_FACILITY LOG_DAEMON
614
682c7051
NB
615extern char *map_num(mapping_t *map, int num);
616extern int map_name(mapping_t *map, char *name);
b640a252 617extern mapping_t r5layout[], r6layout[], pers[], modes[], faultylayout[];
682c7051 618
c2ecf5f6
N
619extern char *map_dev_preferred(int major, int minor, int create,
620 char *prefer);
621static inline char *map_dev(int major, int minor, int create)
622{
623 return map_dev_preferred(major, minor, create, NULL);
624}
64c4757e 625
549e9569 626struct active_array;
2e735d19 627struct metadata_update;
64c4757e 628
80bf9135 629/* 'struct reshape' records the intermediate states of
999b4972
N
630 * a general reshape.
631 * The starting geometry is converted to the 'before' geometry
632 * by at most an atomic level change. They could be the same.
633 * Similarly the 'after' geometry is converted to the final
634 * geometry by at most a level change.
635 * Note that 'before' and 'after' must have the same level.
636 * 'blocks' is the minimum number of sectors for a reshape unit.
637 * This will be a multiple of the stripe size in each of the
638 * 'before' and 'after' geometries.
639 * If 'blocks' is 0, no restriping is necessary.
89ecd3cf
N
640 * 'min_offset_change' is the minimum change to data_offset to
641 * allow the reshape to happen. It is at least the larger of
642 * the old and new chunk sizes, and typically the same as 'blocks'
643 * divided by number of data disks.
999b4972
N
644 */
645struct reshape {
646 int level;
647 int parity; /* number of parity blocks/devices */
648 struct {
649 int layout;
650 int data_disks;
651 } before, after;
652 unsigned long long backup_blocks;
89ecd3cf 653 unsigned long long min_offset_change;
999b4972
N
654 unsigned long long stripes; /* number of old stripes that comprise 'blocks'*/
655 unsigned long long new_size; /* New size of array in sectors */
656};
657
6adfd3af
NB
658/* A superswitch provides entry point the a metadata handler.
659 *
74db60b0 660 * The superswitch primarily operates on some "metadata" that
6adfd3af
NB
661 * is accessed via the 'supertype'.
662 * This metadata has one of three possible sources.
663 * 1/ It is read from a single device. In this case it may not completely
664 * describe the array or arrays as some information might be on other
665 * devices.
666 * 2/ It is read from all devices in a container. In this case all
667 * information is present.
668 * 3/ It is created by ->init_super / ->add_to_super. In this case it will
669 * be complete once enough ->add_to_super calls have completed.
670 *
671 * When creating an array inside a container, the metadata will be
672 * formed by a combination of 2 and 3. The metadata or the array is read,
673 * then new information is added.
674 *
675 * The metadata must sometimes have a concept of a 'current' array
676 * and a 'current' device.
677 * The 'current' array is set by init_super to be the newly created array,
678 * or is set by super_by_fd when it finds it is looking at an array inside
679 * a container.
680 *
681 * The 'current' device is either the device that the metadata was read from
682 * in case 1, or the last device added by add_to_super in case 3.
683 * Case 2 does not identify a 'current' device.
684 */
f9ce90ba 685extern struct superswitch {
6adfd3af
NB
686
687 /* Used to report details of metadata read from a component
688 * device. ->load_super has been called.
689 */
3da92f27 690 void (*examine_super)(struct supertype *st, char *homehost);
061f2c6a 691 void (*brief_examine_super)(struct supertype *st, int verbose);
4737ae25 692 void (*brief_examine_subarrays)(struct supertype *st, int verbose);
0d726f17 693 void (*export_examine_super)(struct supertype *st);
6d388a88 694 int (*examine_badblocks)(struct supertype *st, int fd, char *devname);
74db60b0 695 int (*copy_metadata)(struct supertype *st, int from, int to);
6adfd3af
NB
696
697 /* Used to report details of an active array.
698 * ->load_super was possibly given a 'component' string.
699 */
3da92f27 700 void (*detail_super)(struct supertype *st, char *homehost);
3da92f27 701 void (*brief_detail_super)(struct supertype *st);
0d726f17 702 void (*export_detail_super)(struct supertype *st);
6adfd3af 703
4cce4069 704 /* Optional: platform hardware / firmware details */
9eafa1de
MN
705 int (*detail_platform)(int verbose, int enumerate_only, char *controller_path);
706 int (*export_detail_platform)(int verbose, char *controller_path);
4cce4069 707
6adfd3af
NB
708 /* Used:
709 * to get uuid to storing in bitmap metadata
710 * and 'reshape' backup-data metadata
711 * To see if a device is being re-added to an array it was part of.
712 */
3da92f27 713 void (*uuid_from_super)(struct supertype *st, int uuid[4]);
6adfd3af 714
8592f29d 715 /* Extract generic details from metadata. This could be details about
6adfd3af
NB
716 * the container, or about an individual array within the container.
717 * The determination is made either by:
718 * load_super being given a 'component' string.
719 * validate_geometry determining what to create.
d2ca6449
NB
720 * The info includes both array information and device information.
721 * The particular device should be:
722 * The last device added by add_to_super
723 * The device the metadata was loaded from by load_super
a5d85af7
N
724 * If 'map' is present, then it is an array raid_disks long
725 * (raid_disk must already be set and correct) and it is filled
726 * with 1 for slots that are thought to be active and 0 for slots which
727 * appear to be failed/missing.
95eeceeb 728 * *info is zeroed out before data is added.
6adfd3af 729 */
a5d85af7 730 void (*getinfo_super)(struct supertype *st, struct mdinfo *info, char *map);
5c4cd5da 731 struct mdinfo *(*getinfo_super_disks)(struct supertype *st);
6adfd3af 732 /* Check if the given metadata is flagged as belonging to "this"
9362c1c8 733 * host. 0 for 'no', 1 for 'yes', -1 for "Don't record homehost"
6adfd3af 734 */
3da92f27 735 int (*match_home)(struct supertype *st, char *homehost);
6adfd3af
NB
736
737 /* Make one of several generic modifications to metadata
738 * prior to assembly (or other times).
739 * sparc2.2 - first bug in early 0.90 metadata
740 * super-minor - change name of 0.90 metadata
741 * summaries - 'correct' any redundant data
742 * resync - mark array as dirty to trigger a resync.
743 * uuid - set new uuid - only 0.90 or 1.x
744 * name - change the name of the array (where supported)
745 * homehost - change which host this array is tied to.
746 * devicesize - If metadata is at start of device, change recorded
747 * device size to match actual device size
748 * byteorder - swap bytes for 0.90 metadata
749 *
750 * force-one - mark that device as uptodate, not old or failed.
751 * force-array - mark array as clean if it would not otherwise
752 * assemble
753 * assemble - not sure how this is different from force-one...
754 * linear-grow-new - add a new device to a linear array, but don't
755 * change the size: so superblock still matches
756 * linear-grow-update - now change the size of the array.
16715c01
DL
757 * writemostly - set the WriteMostly1 bit in the superblock devflags
758 * readwrite - clear the WriteMostly1 bit in the superblock devflags
199f1a1f
N
759 * no-bitmap - clear any record that a bitmap is present.
760 * bbl - add a bad-block-log if possible
761 * no-bbl - remove and bad-block-log is it is empty.
762 * revert-reshape - If a reshape is in progress, modify metadata so
763 * it will resume going in the opposite direction.
6adfd3af 764 */
68c7d6d7 765 int (*update_super)(struct supertype *st, struct mdinfo *info,
3da92f27 766 char *update,
e5eac01f
NB
767 char *devname, int verbose,
768 int uuid_set, char *homehost);
6adfd3af
NB
769
770 /* Create new metadata for new array as described. This could
771 * be a new container, or an array in a pre-existing container.
772 * Also used to zero metadata prior to writing it to invalidate old
773 * metadata.
774 */
3da92f27
NB
775 int (*init_super)(struct supertype *st, mdu_array_info_t *info,
776 unsigned long long size, char *name,
83cd1e97
N
777 char *homehost, int *uuid,
778 unsigned long long data_offset);
6adfd3af
NB
779
780 /* update the metadata to include new device, either at create or
781 * when hot-adding a spare.
782 */
f20c3968 783 int (*add_to_super)(struct supertype *st, mdu_disk_info_t *dinfo,
72ca9bcf
N
784 int fd, char *devname,
785 unsigned long long data_offset);
1a64be56
LM
786 /* update the metadata to delete a device,
787 * when hot-removing.
788 */
789 int (*remove_from_super)(struct supertype *st, mdu_disk_info_t *dinfo);
6adfd3af
NB
790
791 /* Write metadata to one device when fixing problems or adding
792 * a new device.
793 */
3da92f27 794 int (*store_super)(struct supertype *st, int fd);
6adfd3af
NB
795
796 /* Write all metadata for this array.
797 */
111d01fc 798 int (*write_init_super)(struct supertype *st);
e2f408a4
N
799 /* Check if metadata read from one device is compatible with an array,
800 * used when assembling an array, or pseudo-assembling was with
801 * "--examine --brief"
802 * If "st" has not yet been loaded the superblock from, "tst" is
803 * moved in, otherwise the superblock in 'st' is compared with
804 * 'tst'.
805 */
64557c33 806 int (*compare_super)(struct supertype *st, struct supertype *tst);
e2f408a4
N
807 /* Load metadata from a single device. If 'devname' is not NULL
808 * print error messages as appropriate */
3da92f27 809 int (*load_super)(struct supertype *st, int fd, char *devname);
e2f408a4
N
810 /* 'fd' is a 'container' md array - load array metadata from the
811 * whole container.
812 */
2b959fbf 813 int (*load_container)(struct supertype *st, int fd, char *devname);
e2f408a4
N
814 /* If 'arg' is a valid name of this metadata type, allocate and
815 * return a 'supertype' for the particular minor version */
82d9eba6 816 struct supertype * (*match_metadata_desc)(char *arg);
e2f408a4
N
817 /* If a device has the given size, and the data_offset has been
818 * requested - work out how much space is available for data.
819 * This involves adjusting for reserved space (e.g. bitmaps)
820 * and for any rounding.
821 * 'mdadm' only calls this for existing arrays where a possible
822 * spare is being added. However some super-handlers call it
823 * internally from validate_geometry when creating an array.
824 */
387fcd59
N
825 __u64 (*avail_size)(struct supertype *st, __u64 size,
826 unsigned long long data_offset);
e2f408a4
N
827 /* This is similar to 'avail_size' in purpose, but is used for
828 * containers for which there is no 'component size' to compare.
829 * This reports that whole-device size which is a minimum
830 */
80e7f8c3 831 unsigned long long (*min_acceptable_spare_size)(struct supertype *st);
e2f408a4
N
832 /* Find somewhere to put a bitmap - possibly auto-size it - and
833 * update the metadata to record this. The array may be newly
834 * created, in which case data_size may be updated, or it might
835 * already exist. Metadata handler can know if init_super
836 * has been called, but not write_init_super.
837 */
3da92f27 838 int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
199171a2 839 int delay, int write_behind,
f9c25f1d 840 unsigned long long size, int may_change, int major);
e2f408a4
N
841 /* Seek 'fd' to start of write-intent-bitmap. Must be an
842 * md-native format bitmap
843 */
3da92f27 844 void (*locate_bitmap)(struct supertype *st, int fd);
e2f408a4
N
845 /* if add_internal_bitmap succeeded for existing array, this
846 * writes it out.
847 */
3da92f27 848 int (*write_bitmap)(struct supertype *st, int fd);
e2f408a4 849 /* Free the superblock and any other allocated data */
3da92f27 850 void (*free_super)(struct supertype *st);
78e44928
NB
851
852 /* validate_geometry is called with an st returned by
853 * match_metadata_desc.
e2f408a4 854 * It should check that the geometry described is compatible with
78e44928
NB
855 * the metadata type. It will be called repeatedly as devices
856 * added to validate changing size and new devices. If there are
857 * inter-device dependencies, it should record sufficient details
858 * so these can be validated.
30f58b22 859 * Both 'size' and '*freesize' are in sectors. chunk is KiB.
ecbd9e81
N
860 * Return value is:
861 * 1: everything is OK
862 * 0: not OK for some reason - if 'verbose', then error was reported.
863 * -1: st->sb was NULL, 'subdev' is a member of a container of this
e2f408a4 864 * type, but array is not acceptable for some reason
ecbd9e81 865 * message was reported even if verbose is 0.
78e44928 866 */
17f25ca6
NB
867 int (*validate_geometry)(struct supertype *st, int level, int layout,
868 int raiddisks,
c21e737b 869 int *chunk, unsigned long long size,
af4348dd 870 unsigned long long data_offset,
2c514b71
NB
871 char *subdev, unsigned long long *freesize,
872 int verbose);
598f0d58 873
e2f408a4
N
874 /* Return a linked list of 'mdinfo' structures for all arrays
875 * in the container. For non-containers, it is like
876 * getinfo_super with an allocated mdinfo.*/
00bbdbda 877 struct mdinfo *(*container_content)(struct supertype *st, char *subarray);
30f58b22
DW
878 /* query the supertype for default geometry */
879 void (*default_geometry)(struct supertype *st, int *level, int *layout, int *chunk); /* optional */
33414a01
DW
880 /* Permit subarray's to be deleted from inactive containers */
881 int (*kill_subarray)(struct supertype *st); /* optional */
aa534678 882 /* Permit subarray's to be modified */
a951a4f7 883 int (*update_subarray)(struct supertype *st, char *subarray,
fa56eddb 884 char *update, struct mddev_ident *ident); /* optional */
7bc71196
DW
885 /* Check if reshape is supported for this external format.
886 * st is obtained from super_by_fd() where st->subarray[0] is
887 * initialized to indicate if reshape is being performed at the
888 * container or subarray level
889 */
016e00f5
AK
890#define APPLY_METADATA_CHANGES 1
891#define ROLLBACK_METADATA_CHANGES 0
892
d04f65f4
N
893 int (*reshape_super)(struct supertype *st,
894 unsigned long long size, int level,
7bc71196 895 int layout, int chunksize, int raid_disks,
41784c88 896 int delta_disks, char *backup, char *dev,
016e00f5 897 int direction,
41784c88 898 int verbose); /* optional */
999b4972
N
899 int (*manage_reshape)( /* optional */
900 int afd, struct mdinfo *sra, struct reshape *reshape,
901 struct supertype *st, unsigned long blocks,
902 int *fds, unsigned long long *offsets,
903 int dests, int *destfd, unsigned long long *destoffsets);
598f0d58 904
549e9569 905/* for mdmon */
cba0191b
NB
906 int (*open_new)(struct supertype *c, struct active_array *a,
907 char *inst);
ed9d66aa
NB
908
909 /* Tell the metadata handler the current state of the array.
910 * This covers whether it is known to be consistent (no pending writes)
01f157d7 911 * and how far along a resync is known to have progressed
ed9d66aa
NB
912 * (in a->resync_start).
913 * resync status is really irrelevant if the array is not consistent,
914 * but some metadata (DDF!) have a place to record the distinction.
1011e834 915 * If 'consistent' is '2', then the array can mark it dirty if a
01f157d7
N
916 * resync/recovery/whatever is required, or leave it clean if not.
917 * Return value is 0 dirty (not consistent) and 1 if clean.
918 * it is only really important if consistent is passed in as '2'.
4e5528c6 919 */
01f157d7 920 int (*set_array_state)(struct active_array *a, int consistent);
7a7cc504
NB
921
922 /* When the state of a device might have changed, we call set_disk to
923 * tell the metadata what the current state is.
924 * Typically this happens on spare->in_sync and (spare|in_sync)->faulty
925 * transitions.
926 * set_disk might be called when the state of the particular disk has
927 * not in fact changed.
928 */
8d45d196 929 void (*set_disk)(struct active_array *a, int n, int state);
2e735d19
NB
930 void (*sync_metadata)(struct supertype *st);
931 void (*process_update)(struct supertype *st,
932 struct metadata_update *update);
5fe6f031
N
933 /* Prepare updates allocates extra memory that might be
934 * needed. If the update cannot be understood, return 0.
935 */
936 int (*prepare_update)(struct supertype *st,
edd8d13c 937 struct metadata_update *update);
549e9569 938
6c3fb95c
NB
939 /* activate_spare will check if the array is degraded and, if it
940 * is, try to find some spare space in the container.
941 * On success, it add appropriate updates (For process_update) to
942 * to the 'updates' list and returns a list of 'mdinfo' identifying
943 * the device, or devices as there might be multiple missing
944 * devices and multiple spares available.
945 */
946 struct mdinfo *(*activate_spare)(struct active_array *a,
947 struct metadata_update **updates);
2cda7640
ML
948 /*
949 * Return statically allocated string that represents metadata specific
950 * controller domain of the disk. The domain is used in disk domain
951 * matching functions. Disks belong to the same domain if the they have
952 * the same domain from mdadm.conf and belong the same metadata domain.
953 * Returning NULL or not providing this handler means that metadata
954 * does not distinguish the differences between disks that belong to
955 * different controllers. They are in the domain specified by
956 * configuration file (mdadm.conf).
957 * In case when the metadata has the notion of domains based on disk
958 * it shall return NULL for disks that do not belong to the controller
959 * the supported domains. Such disks will form another domain and won't
960 * be mixed with supported ones.
961 */
962 const char *(*get_disk_controller_domain)(const char *path);
549e9569 963
ba53ea59
AK
964 /* for external backup area */
965 int (*recover_backup)(struct supertype *st, struct mdinfo *info);
966
0c21b485
PB
967 /* validate container after assemble */
968 int (*validate_container)(struct mdinfo *info);
969
f277ce36 970 int swapuuid; /* true if uuid is bigending rather than hostendian */
d03373f1 971 int external;
4cce4069 972 const char *name; /* canonical metadata name */
0f22b998 973} *superlist[];
82d9eba6 974
0f22b998
N
975extern struct superswitch super0, super1;
976extern struct superswitch super_imsm, super_ddf;
0592faeb 977extern struct superswitch mbr, gpt;
cdddbdbc 978
edd8d13c
NB
979struct metadata_update {
980 int len;
981 char *buf;
982 void *space; /* allocated space that monitor will use */
cb23f1f4
N
983 void **space_list; /* list of allocated spaces that monitor can
984 * use or that it returned.
985 */
edd8d13c
NB
986 struct metadata_update *next;
987};
988
6adfd3af
NB
989/* A supertype holds a particular collection of metadata.
990 * It identifies the metadata type by the superswitch, and the particular
991 * sub-version of that metadata type.
992 * metadata read in or created is stored in 'sb' and 'info'.
993 * There are also fields used by mdmon to track containers.
994 *
352452c3
N
995 * A supertype may refer to:
996 * Just an array, possibly in a container
997 * A container, not identifying any particular array
998 * Info read from just one device, not yet fully describing the array/container.
999 *
1000 *
6adfd3af
NB
1001 * A supertype is created by:
1002 * super_by_fd
1003 * guess_super
1004 * dup_super
1005 */
82d9eba6
NB
1006struct supertype {
1007 struct superswitch *ss;
1008 int minor_version;
ea329559 1009 int max_devs;
4dd2df09 1010 char container_devnm[32]; /* devnm of container */
64557c33 1011 void *sb;
111d01fc 1012 void *info;
afa368f4
N
1013 void *other; /* Hack used to convert v0.90 to v1.0 */
1014 unsigned long long devsize;
23bf42cc 1015 unsigned long long data_offset; /* used by v1.x only */
df3346e6
LM
1016 int ignore_hw_compat; /* used to inform metadata handlers that it should ignore
1017 HW/firmware related incompatability to load metadata.
1018 Used when examining metadata to display content of disk
1019 when user has no hw/firmare compatible system.
1020 */
edd8d13c
NB
1021 struct metadata_update *updates;
1022 struct metadata_update **update_tail;
1023
549e9569
NB
1024 /* extra stuff used by mdmon */
1025 struct active_array *arrays;
549e9569 1026 int sock; /* listen to external programs */
4dd2df09
N
1027 char devnm[32]; /* e.g. md0. This appears in metadata_version:
1028 * external:/md0/12
1029 */
549e9569 1030 int devcnt;
68226a80 1031 int retry_soon;
549e9569
NB
1032
1033 struct mdinfo *devs;
1034
82d9eba6 1035};
f9ce90ba 1036
4725bc31 1037extern struct supertype *super_by_fd(int fd, char **subarray);
54887ad8
N
1038enum guess_types { guess_any, guess_array, guess_partitions };
1039extern struct supertype *guess_super_type(int fd, enum guess_types guess_type);
1040static inline struct supertype *guess_super(int fd) {
1041 return guess_super_type(fd, guess_any);
1042}
3da92f27 1043extern struct supertype *dup_super(struct supertype *st);
beae1dfe 1044extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
3a371610 1045extern int must_be_container(int fd);
0f0749ad 1046extern int dev_size_from_id(dev_t id, unsigned long long *size);
a7c6e3fb 1047void wait_for(char *dev, int fd);
f9ce90ba 1048
5527fc74
N
1049/*
1050 * Data structures for policy management.
1051 * Each device can have a policy structure that lists
1052 * various name/value pairs each possibly with a metadata associated.
1053 * The policy list is sorted by name/value/metadata
1054 */
1055struct dev_policy {
1056 struct dev_policy *next;
1057 char *name; /* None of these strings are allocated. They are
1058 * all just references to strings which are known
1059 * to exist elsewhere.
1060 * name and metadata can be compared by address equality.
1061 */
1062 const char *metadata;
2cda7640 1063 const char *value;
5527fc74
N
1064};
1065
4e8d9f0a 1066extern char pol_act[], pol_domain[], pol_metadata[], pol_auto[];
5527fc74
N
1067
1068/* iterate over the sublist starting at list, having the same
1069 * 'name' as 'list', and matching the given metadata (Where
1070 * NULL matches anything
1071 */
1072#define pol_for_each(item, list, _metadata) \
1073 for (item = list; \
1074 item && item->name == list->name; \
1075 item = item->next) \
1076 if (!(!_metadata || !item->metadata || _metadata == item->metadata)) \
1077 ; else
1078
1079/*
1080 * policy records read from mdadm are largely just name-value pairs.
1081 * The names are constants, not strdupped
1082 */
1083struct pol_rule {
1084 struct pol_rule *next;
1085 char *type; /* rule_policy or rule_part */
1086 struct rule {
1087 struct rule *next;
1088 char *name;
1089 char *value;
1090 char *dups; /* duplicates of 'value' with a partNN appended */
1091 } *rule;
1092};
1093
1094extern char rule_policy[], rule_part[];
1095extern char rule_path[], rule_type[];
1096extern char type_part[], type_disk[];
1097
1098extern void policyline(char *line, char *type);
4e8d9f0a 1099extern void policy_add(char *type, ...);
5527fc74
N
1100extern void policy_free(void);
1101
73c9c47c 1102extern struct dev_policy *path_policy(char *path, char *type);
5527fc74 1103extern struct dev_policy *disk_policy(struct mdinfo *disk);
4dd2df09 1104extern struct dev_policy *devid_policy(int devid);
5527fc74
N
1105extern void dev_policy_free(struct dev_policy *p);
1106
e78dda3b
N
1107//extern void pol_new(struct dev_policy **pol, char *name, char *val, char *metadata);
1108extern void pol_add(struct dev_policy **pol, char *name, char *val, char *metadata);
5527fc74
N
1109extern struct dev_policy *pol_find(struct dev_policy *pol, char *name);
1110
e3bb5f14
N
1111enum policy_action {
1112 act_default,
1113 act_include,
1114 act_re_add,
d2db3045
N
1115 act_spare, /* This only applies to bare devices */
1116 act_spare_same_slot, /* this allows non-bare devices,
1117 * but only if recent removal */
1118 act_force_spare, /* this allow non-bare devices in any case */
e3bb5f14
N
1119 act_err
1120};
1121
1122extern int policy_action_allows(struct dev_policy *plist, const char *metadata,
1123 enum policy_action want);
1124extern int disk_action_allows(struct mdinfo *disk, const char *metadata,
1125 enum policy_action want);
f5f12c84
N
1126
1127struct domainlist {
1128 struct domainlist *next;
2cda7640 1129 const char *dom;
f5f12c84
N
1130};
1131
1132extern int domain_test(struct domainlist *dom, struct dev_policy *pol,
1133 const char *metadata);
1134extern struct domainlist *domain_from_array(struct mdinfo *mdi,
1135 const char *metadata);
4dd2df09 1136extern void domainlist_add_dev(struct domainlist **dom, int devid,
e78dda3b 1137 const char *metadata);
f5f12c84
N
1138extern void domain_free(struct domainlist *dl);
1139extern void domain_merge(struct domainlist **domp, struct dev_policy *pol,
1140 const char *metadata);
e78dda3b 1141void domain_add(struct domainlist **domp, char *domain);
f5f12c84 1142
403410eb
PC
1143extern void policy_save_path(char *id_path, struct map_ent *array);
1144extern int policy_check_path(struct mdinfo *disk, struct map_ent *array);
1145
838acbc2
NB
1146#if __GNUC__ < 3
1147struct stat64;
1148#endif
1149
45e878bb
NB
1150#define HAVE_NFTW we assume
1151#define HAVE_FTW
1152
2df1f269 1153#ifdef __UCLIBC__
45e878bb 1154# include <features.h>
2df1f269
BRF
1155# ifndef __UCLIBC_HAS_LFS__
1156# define lseek64 lseek
1157# endif
45e878bb
NB
1158# ifndef __UCLIBC_HAS_FTW__
1159# undef HAVE_FTW
1160# undef HAVE_NFTW
1161# endif
1162#endif
1163
1164#ifdef __dietlibc__
1165# undef HAVE_NFTW
1166#endif
1167
e39b673e 1168#if defined(__KLIBC__)
1169# undef HAVE_NFTW
1170# undef HAVE_FTW
1171#endif
1172
45e878bb 1173#ifndef HAVE_NFTW
173fc515 1174# define FTW_PHYS 1
45e878bb
NB
1175# ifndef HAVE_FTW
1176 struct FTW {};
173fc515
NB
1177# endif
1178#endif
1179
45e878bb
NB
1180#ifdef HAVE_FTW
1181# include <ftw.h>
1182#endif
1183
173fc515
NB
1184extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
1185
64c4757e 1186extern int Manage_ro(char *devname, int fd, int readonly);
d5a40416 1187extern int Manage_run(char *devname, int fd, struct context *c);
fe7e0e64
N
1188extern int Manage_stop(char *devname, int fd, int quiet,
1189 int will_retry);
64c4757e 1190extern int Manage_subdevs(char *devname, int fd,
833bb0f8 1191 struct mddev_dev *devlist, int verbose, int test,
11b391ec 1192 char *update, int force);
1f48664b 1193extern int autodetect(void);
e5329c37 1194extern int Grow_Add_device(char *devname, int fd, char *newdev);
50f01ba5
N
1195extern int Grow_addbitmap(char *devname, int fd,
1196 struct context *c, struct shape *s);
32754b7d 1197extern int Grow_reshape(char *devname, int fd,
e2e53a2d 1198 struct mddev_dev *devlist,
40c9a66a 1199 unsigned long long data_offset,
32754b7d 1200 struct context *c, struct shape *s);
06b0d786 1201extern int Grow_restart(struct supertype *st, struct mdinfo *info,
ea0ebe96 1202 int *fdlist, int cnt, char *backup_file, int verbose);
e9e43ec3 1203extern int Grow_continue(int mdfd, struct supertype *st,
b76b30e0 1204 struct mdinfo *info, char *backup_file,
06e293d0 1205 int forked, int freeze_reshape);
b76b30e0 1206
3f54bd62
AK
1207extern int restore_backup(struct supertype *st,
1208 struct mdinfo *content,
1209 int working_disks,
1210 int spares,
54ded86f 1211 char **backup_filep,
3f54bd62 1212 int verbose);
2dddadb0
AK
1213extern int Grow_continue_command(char *devname, int fd,
1214 char *backup_file, int verbose);
64c4757e 1215
7f91af49 1216extern int Assemble(struct supertype *st, char *mddev,
fa56eddb 1217 struct mddev_ident *ident,
87f26d14 1218 struct mddev_dev *devlist,
4977146a 1219 struct context *c);
64c4757e 1220
a4e8316a
N
1221extern int Build(char *mddev, struct mddev_dev *devlist,
1222 struct shape *s, struct context *c);
64c4757e 1223
7f91af49 1224extern int Create(struct supertype *st, char *mddev,
171dccc8 1225 char *name, int *uuid,
a655e550 1226 int subdevs, struct mddev_dev *devlist,
99cc42f4 1227 struct shape *s,
40c9a66a
N
1228 struct context *c,
1229 unsigned long long data_offset);
64c4757e 1230
ef898ce6 1231extern int Detail(char *dev, struct context *c);
9eafa1de 1232extern int Detail_Platform(struct superswitch *ss, int scan, int verbose, int export, char *controller_path);
e0d19036 1233extern int Query(char *dev);
6d388a88 1234extern int ExamineBadblocks(char *devname, int brief, struct supertype *forcest);
eec3f887
N
1235extern int Examine(struct mddev_dev *devlist, struct context *c,
1236 struct supertype *forcest);
a655e550 1237extern int Monitor(struct mddev_dev *devlist,
e0d19036 1238 char *mailaddr, char *alert_cmd,
95c50205
N
1239 struct context *c,
1240 int daemonise, int oneshot,
1241 int dosyslog, char *pidfile, int increments,
1242 int share);
64c4757e 1243
ba728be7
N
1244extern int Kill(char *dev, struct supertype *st, int force, int verbose, int noexcl);
1245extern int Kill_subarray(char *dev, char *subarray, int verbose);
fa56eddb 1246extern int Update_subarray(char *dev, char *subarray, char *update, struct mddev_ident *ident, int quiet);
b90c0e9a 1247extern int Wait(char *dev);
9f1da824 1248extern int WaitClean(char *dev, int sock, int verbose);
a740cf64 1249extern int SetAction(char *dev, char *action);
9a9dab36 1250
b11fe74d 1251extern int Incremental(struct mddev_dev *devlist, struct context *c,
11b6d91d 1252 struct supertype *st);
8382f19b 1253extern void RebuildMap(void);
d5a40416 1254extern int IncrementalScan(struct context *c, char *devnm);
950bc344 1255extern int IncrementalRemove(char *devname, char *path, int verbose);
c82f047c
NB
1256extern int CreateBitmap(char *filename, int force, char uuid[16],
1257 unsigned long chunksize, unsigned long daemon_sleep,
dfd4d8ee 1258 unsigned long write_behind,
dcec9ee5
NB
1259 unsigned long long array_size,
1260 int major);
55935d51 1261extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
20b60dcd 1262extern int Write_rules(char *rule_name);
bf4fb153 1263extern int bitmap_update_uuid(int fd, int *uuid, int swap);
2a528478 1264extern unsigned long bitmap_sectors(struct bitmap_super_s *bsb);
74db60b0
N
1265extern int Dump_metadata(char *dev, char *dir, struct context *c,
1266 struct supertype *st);
1267extern int Restore_metadata(char *dev, char *dir, struct context *c,
1268 struct supertype *st, int only);
c82f047c 1269
64c4757e 1270extern int md_get_version(int fd);
e0d19036 1271extern int get_linux_version(void);
bc77ed53 1272extern int mdadm_version(char *version);
51d4261c 1273extern unsigned long long parse_size(char *size);
64c4757e 1274extern int parse_uuid(char *str, int uuid[4]);
4a06e2c2
N
1275extern int parse_layout_10(char *layout);
1276extern int parse_layout_faulty(char *layout);
79868890 1277extern long parse_num(char *num);
682c7051
NB
1278extern int check_ext2(int fd, char *name);
1279extern int check_reiser(int fd, char *name);
1280extern int check_raid(int fd, char *name);
53ed6ac3
KW
1281extern int check_partitions(int fd, char *dname,
1282 unsigned long long freesize,
1283 unsigned long long size);
64c4757e 1284
dd0781e5 1285extern int get_mdp_major(void);
cc742d38 1286extern int get_maj_min(char *dev, int *major, int *minor);
8b0dabea 1287extern int dev_open(char *dev, int flags);
4dd2df09 1288extern int open_dev(char *devnm);
8832342d 1289extern void reopen_mddev(int mdfd);
4dd2df09
N
1290extern int open_dev_flags(char *devnm, int flags);
1291extern int open_dev_excl(char *devnm);
8d80900b 1292extern int is_standard(char *dev, int *nump);
9008ed1c 1293extern int same_dev(char *one, char *two);
9eafa1de 1294extern int compare_paths (char* path1,char* path2);
a7dec3fd 1295extern void enable_fds(int devices);
dd0781e5 1296
f1ae21c4 1297extern int parse_auto(char *str, char *msg, int config);
fa56eddb 1298extern struct mddev_ident *conf_get_ident(char *dev);
a655e550 1299extern struct mddev_dev *conf_get_devs(void);
8382f19b 1300extern int conf_test_dev(char *devname);
4e8d9f0a 1301extern int conf_test_metadata(const char *version, struct dev_policy *pol, int is_homehost);
8aec876d
NB
1302extern struct createinfo *conf_get_create_info(void);
1303extern void set_conffile(char *file);
1304extern char *conf_get_mailaddr(void);
1305extern char *conf_get_mailfrom(void);
1306extern char *conf_get_program(void);
0ac91628 1307extern char *conf_get_homehost(int *require_homehostp);
e0d19036 1308extern char *conf_line(FILE *file);
98c6faba 1309extern char *conf_word(FILE *file, int allow_key);
7103b9b8
N
1310extern void print_quoted(char *str);
1311extern void print_escape(char *str);
06d2ffc3 1312extern int use_udev(void);
2eba8496 1313extern unsigned long GCD(unsigned long a, unsigned long b);
0ac91628 1314extern int conf_name_is_free(char *name);
7c336758 1315extern int conf_verify_devnames(struct mddev_ident *array_list);
0ac91628 1316extern int devname_matches(char *name, char *match);
2244d1a9
N
1317extern struct mddev_ident *conf_match(struct supertype *st,
1318 struct mdinfo *info,
1319 char *devname,
1320 int verbose, int *rvp);
6d11ec6f 1321extern int experimental(void);
0ac91628 1322
e0d19036
NB
1323extern void free_line(char *line);
1324extern int match_oneof(char *devices, char *devname);
e0d19036 1325extern void uuid_from_super(int uuid[4], mdp_super_t *super);
22e263f6 1326extern const int uuid_zero[4];
f277ce36 1327extern int same_uuid(int a[4], int b[4], int swapuuid);
350f29f9 1328extern void copy_uuid(void *a, int b[4], int swapuuid);
aae5a112 1329extern char *__fname_from_uuid(int id[4], int swap, char *buf, char sep);
d7288ddc 1330extern char *fname_from_uuid(struct supertype *st,
ff54de6e 1331 struct mdinfo *info, char *buf, char sep);
4b1ac34b 1332extern unsigned long calc_csum(void *super, int bytes);
583315d9 1333extern int enough(int level, int raid_disks, int layout, int clean,
de5a472e 1334 char *avail);
8453e704 1335extern int enough_fd(int fd);
e0d19036 1336extern int ask(char *mesg);
8fac0577 1337extern unsigned long long get_component_size(int fd);
0430ed48 1338extern void remove_partitions(int fd);
691c6ee1 1339extern int test_partition(int fd);
bfd76b93 1340extern int test_partition_from_id(dev_t id);
577e8448 1341extern int get_data_disks(int level, int layout, int raid_disks);
5f8097be
NB
1342extern unsigned long long calc_array_size(int level, int raid_disks, int layout,
1343 int chunksize, unsigned long long devsize);
edd8d13c
NB
1344extern int flush_metadata_updates(struct supertype *st);
1345extern void append_metadata_update(struct supertype *st, void *buf, int len);
6234c63c 1346extern int assemble_container_content(struct supertype *st, int mdfd,
11b6d91d
N
1347 struct mdinfo *content,
1348 struct context *c,
9ca39acb
N
1349 char *chosen_name, int *result);
1350#define INCR_NO 1
1351#define INCR_UNSAFE 2
1352#define INCR_ALREADY 4
1353#define INCR_YES 8
326727d9
AC
1354extern struct mdinfo *container_choose_spares(struct supertype *st,
1355 unsigned long long min_size,
1356 struct domainlist *domlist,
1357 char *spare_group,
1358 const char *metadata, int get_one);
d52bb542 1359extern int move_spare(char *from_devname, char *to_devname, dev_t devid);
7801ac20
N
1360extern int add_disk(int mdfd, struct supertype *st,
1361 struct mdinfo *sra, struct mdinfo *info);
de6ae750
N
1362extern int remove_disk(int mdfd, struct supertype *st,
1363 struct mdinfo *sra, struct mdinfo *info);
f35f2525 1364extern int set_array_info(int mdfd, struct supertype *st, struct mdinfo *info);
1e5c6983 1365unsigned long long min_recovery_start(struct mdinfo *array);
cd29a5c8 1366
56eb10c0 1367extern char *human_size(long long bytes);
f0ec6710 1368extern char *human_size_brief(long long bytes, int prefix);
e4965ef8 1369extern void print_r10_layout(int layout);
e0d19036 1370
4dd2df09 1371extern char *find_free_devnm(int use_partitions);
63152c1b 1372
e0d19036 1373extern void put_md_name(char *name);
bc17158d 1374extern char *devid2kname(int devid);
4dd2df09
N
1375extern char *devid2devnm(int devid);
1376extern int devnm2devid(char *devnm);
1377extern char *get_md_name(char *devnm);
e0d19036 1378
c913b90e 1379extern char DefaultConfFile[];
b5e64645 1380
69207ff6
N
1381extern int create_mddev(char *dev, char *name, int autof, int trustworthy,
1382 char *chosen);
1383/* values for 'trustworthy' */
1384#define LOCAL 1
d1d3482b 1385#define LOCAL_ANY 10
69207ff6
N
1386#define FOREIGN 2
1387#define METADATA 3
6be1d39d 1388extern int open_mddev(char *dev, int report_errors);
a322f70c 1389extern int open_container(int fd);
4dd2df09
N
1390extern int metadata_container_matches(char *metadata, char *devnm);
1391extern int metadata_subdev_matches(char *metadata, char *devnm);
33414a01
DW
1392extern int is_container_member(struct mdstat_ent *ent, char *devname);
1393extern int is_subarray_active(char *subarray, char *devname);
feab51f8 1394extern int open_subarray(char *dev, char *subarray, struct supertype *st, int quiet);
33414a01 1395extern struct superswitch *version_to_superswitch(char *vers);
b5e64645 1396
4dd2df09
N
1397extern int mdmon_running(char *devnm);
1398extern int mdmon_pid(char *devnm);
40ebbb9c 1399extern int check_env(char *name);
148acb7b 1400extern __u32 random32(void);
4dd2df09 1401extern int start_mdmon(char *devnm);
a931db9e 1402
999b4972
N
1403extern int child_monitor(int afd, struct mdinfo *sra, struct reshape *reshape,
1404 struct supertype *st, unsigned long stripes,
1405 int *fds, unsigned long long *offsets,
1406 int dests, int *destfd, unsigned long long *destoffsets);
10f22854 1407void abort_reshape(struct mdinfo *sra);
999b4972 1408
afa368f4
N
1409void *super1_make_v0(struct supertype *st, struct mdinfo *info, mdp_super_t *sb0);
1410
11877f4d 1411extern void fmt_devname(char *name, int num);
4dd2df09
N
1412extern char *stat2devnm(struct stat *st);
1413extern char *fd2devnm(int fd);
a931db9e 1414
a9c15847
N
1415extern int in_initrd(void);
1416
2d762ade 1417#define _ROUND_UP(val, base) (((val) + (base) - 1) & ~(base - 1))
de897065
JS
1418#define ROUND_UP(val, base) _ROUND_UP(val, (typeof(val))(base))
1419#define ROUND_UP_PTR(ptr, base) ((typeof(ptr)) \
1420 (ROUND_UP((unsigned long)(ptr), base)))
6416d527 1421
3c558363
N
1422static inline int is_subarray(char *vers)
1423{
e9dd1598 1424 /* The version string for a 'subarray' (an array in a container)
1011e834 1425 * is
e9dd1598 1426 * /containername/componentname for normal read-write arrays
746a6567
N
1427 * -containername/componentname for arrays which mdmon must not
1428 * reconfigure. They might be read-only
1429 * or might be undergoing reshape etc.
e9dd1598
N
1430 * containername is e.g. md0, md_d1
1431 * componentname is dependant on the metadata. e.g. '1' 'S1' ...
1432 */
1433 return (*vers == '/' || *vers == '-');
3c558363
N
1434}
1435
e5408a32
DW
1436static inline char *to_subarray(struct mdstat_ent *ent, char *container)
1437{
1438 return &ent->metadata_version[10+strlen(container)+1];
1439}
1440
2a24d7b6
DW
1441#ifdef DEBUG
1442#define dprintf(fmt, arg...) \
1443 fprintf(stderr, fmt, ##arg)
1444#else
1445#define dprintf(fmt, arg...) \
1446 ({ if (0) fprintf(stderr, fmt, ##arg); 0; })
1447#endif
1a0ee0ba
DK
1448#include <assert.h>
1449#include <stdarg.h>
1450static inline int xasprintf(char **strp, const char *fmt, ...) {
1451 va_list ap;
1452 int ret;
1453 va_start(ap, fmt);
089485cb 1454 ret = vasprintf(strp, fmt, ap);
1a0ee0ba
DK
1455 va_end(ap);
1456 assert(ret >= 0);
1457 return ret;
1458}
2a24d7b6 1459
e7b84f9d
N
1460#define pr_err(fmt ...) fprintf(stderr, Name ": " fmt)
1461#define cont_err(fmt ...) fprintf(stderr, " " fmt)
1462
503975b9
N
1463void *xmalloc(size_t len);
1464void *xrealloc(void *ptr, size_t len);
1465void *xcalloc(size_t num, size_t size);
1466char *xstrdup(const char *str);
1467
b5e64645
NB
1468#define LEVEL_MULTIPATH (-4)
1469#define LEVEL_LINEAR (-1)
1470#define LEVEL_FAULTY (-5)
1471
17f25ca6
NB
1472/* kernel module doesn't know about these */
1473#define LEVEL_CONTAINER (-100)
a322f70c 1474#define LEVEL_UNSUPPORTED (-200)
17f25ca6 1475
56cb05c4
N
1476/* the kernel does know about this one ... */
1477#define LEVEL_NONE (-1000000)
1478
b5e64645
NB
1479/* faulty stuff */
1480
1481#define WriteTransient 0
1482#define ReadTransient 1
1483#define WritePersistent 2
1484#define ReadPersistent 3
1485#define WriteAll 4 /* doesn't go to device */
1486#define ReadFixable 5
1487#define Modes 6
1488
1489#define ClearErrors 31
1490#define ClearFaults 30
1491
1492#define AllPersist 100 /* internal use only */
1493#define NoPersist 101
1494
1495#define ModeMask 0x1f
1496#define ModeShift 5
fe6729fa 1497
fe6729fa
NB
1498#ifdef __TINYC__
1499#undef minor
1500#undef major
1501#undef makedev
1502#define minor(x) ((x)&0xff)
1503#define major(x) (((x)>>8)&0xff)
1504#define makedev(M,m) (((M)<<8) | (m))
1505#endif
1506
b640a252 1507/* for raid4/5/6 */
e86c9dd6
NB
1508#define ALGORITHM_LEFT_ASYMMETRIC 0
1509#define ALGORITHM_RIGHT_ASYMMETRIC 1
1510#define ALGORITHM_LEFT_SYMMETRIC 2
1511#define ALGORITHM_RIGHT_SYMMETRIC 3
b640a252
N
1512
1513/* Define non-rotating (raid4) algorithms. These allow
1514 * conversion of raid4 to raid5.
1515 */
1516#define ALGORITHM_PARITY_0 4 /* P or P,Q are initial devices */
1517#define ALGORITHM_PARITY_N 5 /* P or P,Q are final devices. */
1518
1519/* DDF RAID6 layouts differ from md/raid6 layouts in two ways.
1520 * Firstly, the exact positioning of the parity block is slightly
1521 * different between the 'LEFT_*' modes of md and the "_N_*" modes
1522 * of DDF.
1523 * Secondly, or order of datablocks over which the Q syndrome is computed
1524 * is different.
1525 * Consequently we have different layouts for DDF/raid6 than md/raid6.
1526 * These layouts are from the DDFv1.2 spec.
1527 * Interestingly DDFv1.2-Errata-A does not specify N_CONTINUE but
1528 * leaves RLQ=3 as 'Vendor Specific'
1529 */
1530
1531#define ALGORITHM_ROTATING_ZERO_RESTART 8 /* DDF PRL=6 RLQ=1 */
1532#define ALGORITHM_ROTATING_N_RESTART 9 /* DDF PRL=6 RLQ=2 */
1533#define ALGORITHM_ROTATING_N_CONTINUE 10 /*DDF PRL=6 RLQ=3 */
1534
b640a252
N
1535/* For every RAID5 algorithm we define a RAID6 algorithm
1536 * with exactly the same layout for data and parity, and
1537 * with the Q block always on the last device (N-1).
1538 * This allows trivial conversion from RAID5 to RAID6
1539 */
1540#define ALGORITHM_LEFT_ASYMMETRIC_6 16
1541#define ALGORITHM_RIGHT_ASYMMETRIC_6 17
1542#define ALGORITHM_LEFT_SYMMETRIC_6 18
1543#define ALGORITHM_RIGHT_SYMMETRIC_6 19
1544#define ALGORITHM_PARITY_0_6 20
1545#define ALGORITHM_PARITY_N_6 ALGORITHM_PARITY_N
1546
33a6535d
AW
1547/* Define PATH_MAX in case we don't use glibc or standard library does
1548 * not have PATH_MAX defined. Assume max path length is 4K characters.
1549 */
1550#ifndef PATH_MAX
1551#define PATH_MAX 4096
1552#endif
1553
9dad51d4
N
1554#define RESYNC_NONE -1
1555#define RESYNC_DELAYED -2
1556#define RESYNC_PENDING -3
1557#define RESYNC_UNKNOWN -4
a0963a86 1558
480f3566
N
1559/* When using "GET_DISK_INFO" it isn't certain how high
1560 * we need to check. So we impose an absolute limit of
1561 * MAX_DISKS. This needs to be much more than the largest
1562 * number of devices any metadata can support. Currently
1563 * v1.x can support 1920
1564 */
1565#define MAX_DISKS 4096
1566
d04f65f4
N
1567/* Sometimes the 'size' value passed needs to mean "Maximum".
1568 * In those cases with use MAX_SIZE
1569 */
1570#define MAX_SIZE 1
822e393a
N
1571
1572/* We want to use unsigned numbers for sector counts, but need
1573 * a value for 'invalid'. Use '1'.
1574 */
1575#define INVALID_SECTORS 1
72ca9bcf
N
1576/* And another special number needed for --data_offset=variable */
1577#define VARIABLE_OFFSET 3