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