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