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