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