2 * mdadm - manage Linux "md" devices aka RAID arrays.
4 * Copyright (C) 2001-2009 Neil Brown <neilb@suse.de>
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.
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.
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
22 * Email: <neilb@suse.de>
26 #define _FILE_OFFSET_BITS 64
28 #if !defined(__dietlibc__) && !defined(__KLIBC__)
29 extern __off64_t lseek64
__P ((int __fd
, __off64_t __offset
, int __whence
));
31 # if defined(__NO_STAT64) || __WORDSIZE != 32
32 # define lseek64 lseek
36 #include <sys/types.h>
49 /* dietlibc has deprecated random and srandom!! */
55 #include <linux/kdev_t.h>
56 /*#include <linux/fs.h> */
57 #include <sys/mount.h>
58 #include <asm/types.h>
59 #include <sys/ioctl.h>
61 #define MdpMinorShift 6
64 #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
67 #define DEFAULT_BITMAP_CHUNK 4096
68 #define DEFAULT_BITMAP_DELAY 5
69 #define DEFAULT_MAX_WRITE_BEHIND 256
71 /* MAP_DIR should be somewhere that persists across the pivotroot
72 * from early boot to late boot.
73 * Currently /dev seems to be the only option on most distros.
76 #define MAP_DIR "/dev/.mdadm"
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"
82 #define MAP_FILE "map"
84 /* MDMON_DIR is where pid and socket files used for communicating
85 * with mdmon normally live. It *should* be /var/run, but when
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.
93 #define MDMON_DIR "/dev/.mdadm/"
94 #endif /* MDMON_DIR */
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
100 #ifndef FAILED_SLOTS_DIR
101 #define FAILED_SLOTS_DIR "/dev/.mdadm/failed-slots"
102 #endif /* FAILED_SLOTS */
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)
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)
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)
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)
160 # error "unknown endianness."
162 #endif /* __KLIBC__ */
166 * min()/max()/clamp() macros that also do
167 * strict type-checking.. See the
168 * "unnecessary" pointer comparison.
170 #define min(x, y) ({ \
171 typeof(x) _min1 = (x); \
172 typeof(y) _min2 = (y); \
173 (void) (&_min1 == &_min2); \
174 _min1 < _min2 ? _min1 : _min2; })
176 #define max(x, y) ({ \
177 typeof(x) _max1 = (x); \
178 typeof(y) _max2 = (y); \
179 (void) (&_max1 == &_max2); \
180 _max1 > _max2 ? _max1 : _max2; })
182 /* general information that might be extracted from a superblock */
184 mdu_array_info_t array
;
185 mdu_disk_info_t disk
;
189 unsigned long long data_offset
;
190 unsigned long long component_size
; /* same as array.size, except in
191 * sectors and up to 64bits.
193 unsigned long long custom_array_size
; /* size for non-default sized
194 * arrays (in sectors)
197 unsigned long long reshape_progress
;
199 unsigned long long resync_start
; /* per-array resync position */
200 unsigned long long recovery_start
; /* per-device rebuild position */
201 #define MaxSector (~0ULL) /* resync/recovery complete position */
203 unsigned long safe_mode_delay
; /* ms delay to mark clean */
204 int new_level
, delta_disks
, new_layout
, new_chunk
;
206 unsigned long cache_size
; /* size of raid456 stripe cache*/
208 char text_version
[50];
209 void *update_private
; /* for passing metadata-format
210 * specific update data
211 * between successive calls to
215 int container_member
; /* for assembling external-metatdata arrays
216 * This is to be used internally by metadata
218 int container_enough
; /* flag external handlers can set to
219 * indicate that subarrays have not enough (-1),
220 * enough to start (0), or all expected disks (1) */
225 /* Device info for mdmon: */
230 #define DS_WRITE_MOSTLY 4
232 #define DS_BLOCKED 16
233 #define DS_REMOVE 1024
234 #define DS_UNBLOCK 2048
235 int prev_state
, curr_state
, next_state
;
245 struct supertype
*supertype
;
262 extern char short_options
[];
263 extern char short_bitmap_options
[];
264 extern char short_bitmap_auto_options
[];
265 extern struct option long_options
[];
266 extern char Version
[], Usage
[], Help
[], OptionHelp
[],
267 Help_create
[], Help_build
[], Help_assemble
[], Help_grow
[],
269 Help_manage
[], Help_misc
[], Help_monitor
[], Help_config
[];
271 /* for option that don't have short equivilents, we assign arbitrary
272 * small numbers. '1' means an undecorated option, so we start at '2'.
273 * (note we must stop before we get to 65 i.e. 'A')
275 enum special_options
{
290 UpdateSubarray
, /* 16 */
295 /* structures read from config file */
296 /* List of mddevice names and identifiers
297 * Identifiers can be:
299 * super-minor=decimal-minor-number-from-superblock
300 * devices=comma,separated,list,of,device,names,with,wildcards
302 * If multiple fields are present, the intersection of all matching
303 * devices is considered
305 #define UnSet (0xfffe)
315 char *devices
; /* comma separated list of device
316 * names with wild cards
321 struct supertype
*st
;
322 int autof
; /* 1 for normal, 2 for partitioned */
327 char *container
; /* /dev/whatever name of container, or
328 * uuid of container. You would expect
329 * this to be the 'devname' or UUID
330 * of some other entry.
332 char *member
; /* subarray within a container */
334 struct mddev_ident
*next
;
336 /* fields needed by different users of this structure */
337 int assembled
; /* set when assembly succeeds */
341 /* List of device names - wildcards expanded */
344 char disposition
; /* 'a' for add, 'r' for remove, 'f' for fail.
345 * Not set for names read from .config
347 char writemostly
; /* 1 for 'set writemostly', 2 for 'clear writemostly' */
349 char used
; /* set when used */
350 struct mddev_dev
*next
;
353 typedef struct mapping
{
364 char *pattern
; /* U or up, _ for down */
365 int percent
; /* -1 if no resync */
366 int resync
; /* 3 if check, 2 if reshape, 1 if resync, 0 if recovery */
370 char * metadata_version
;
373 struct dev_member
*next
;
375 struct mdstat_ent
*next
;
378 extern struct mdstat_ent
*mdstat_read(int hold
, int start
);
379 extern void free_mdstat(struct mdstat_ent
*ms
);
380 extern void mdstat_wait(int seconds
);
381 extern void mdstat_wait_fd(int fd
, const sigset_t
*sigmask
);
382 extern int mddev_busy(int devnum
);
383 extern struct mdstat_ent
*mdstat_by_component(char *name
);
386 struct map_ent
*next
;
393 extern int map_update(struct map_ent
**mpp
, int devnum
, char *metadata
,
394 int uuid
[4], char *path
);
395 extern void map_remove(struct map_ent
**map
, int devnum
);
396 extern struct map_ent
*map_by_uuid(struct map_ent
**map
, int uuid
[4]);
397 extern struct map_ent
*map_by_devnum(struct map_ent
**map
, int devnum
);
398 extern struct map_ent
*map_by_name(struct map_ent
**map
, char *name
);
399 extern void map_read(struct map_ent
**melp
);
400 extern int map_write(struct map_ent
*mel
);
401 extern void map_delete(struct map_ent
**mapp
, int devnum
);
402 extern void map_free(struct map_ent
*map
);
403 extern void map_add(struct map_ent
**melp
,
404 int devnum
, char *metadata
, int uuid
[4], char *path
);
405 extern int map_lock(struct map_ent
**melp
);
406 extern void map_unlock(struct map_ent
**melp
);
408 /* various details can be requested */
409 enum sysfs_read_flags
{
410 GET_LEVEL
= (1 << 0),
411 GET_LAYOUT
= (1 << 1),
412 GET_COMPONENT
= (1 << 2),
413 GET_CHUNK
= (1 << 3),
414 GET_CACHE
= (1 << 4),
415 GET_MISMATCH
= (1 << 5),
416 GET_VERSION
= (1 << 6),
417 GET_DISKS
= (1 << 7),
418 GET_DEGRADED
= (1 << 8),
419 GET_SAFEMODE
= (1 << 9),
420 GET_DEVS
= (1 << 10), /* gets role, major, minor */
421 GET_OFFSET
= (1 << 11),
422 GET_SIZE
= (1 << 12),
423 GET_STATE
= (1 << 13),
424 GET_ERROR
= (1 << 14),
427 /* If fd >= 0, get the array it is open on,
428 * else use devnum. >=0 -> major9. <0.....
430 extern int sysfs_open(int devnum
, char *devname
, char *attr
);
431 extern void sysfs_init(struct mdinfo
*mdi
, int fd
, int devnum
);
432 extern void sysfs_free(struct mdinfo
*sra
);
433 extern struct mdinfo
*sysfs_read(int fd
, int devnum
, unsigned long options
);
434 extern int sysfs_attr_match(const char *attr
, const char *str
);
435 extern int sysfs_match_word(const char *word
, char **list
);
436 extern int sysfs_set_str(struct mdinfo
*sra
, struct mdinfo
*dev
,
437 char *name
, char *val
);
438 extern int sysfs_set_num(struct mdinfo
*sra
, struct mdinfo
*dev
,
439 char *name
, unsigned long long val
);
440 extern int sysfs_uevent(struct mdinfo
*sra
, char *event
);
441 extern int sysfs_get_fd(struct mdinfo
*sra
, struct mdinfo
*dev
,
443 extern int sysfs_fd_get_ll(int fd
, unsigned long long *val
);
444 extern int sysfs_get_ll(struct mdinfo
*sra
, struct mdinfo
*dev
,
445 char *name
, unsigned long long *val
);
446 extern int sysfs_fd_get_str(int fd
, char *val
, int size
);
447 extern int sysfs_attribute_available(struct mdinfo
*sra
, struct mdinfo
*dev
,
449 extern int sysfs_get_str(struct mdinfo
*sra
, struct mdinfo
*dev
,
450 char *name
, char *val
, int size
);
451 extern int sysfs_set_safemode(struct mdinfo
*sra
, unsigned long ms
);
452 extern int sysfs_set_array(struct mdinfo
*info
, int vers
);
453 extern int sysfs_add_disk(struct mdinfo
*sra
, struct mdinfo
*sd
, int resume
);
454 extern int sysfs_disk_to_scsi_id(int fd
, __u32
*id
);
455 extern int sysfs_unique_holder(int devnum
, long rdev
);
456 extern int sysfs_freeze_array(struct mdinfo
*sra
);
457 extern int load_sys(char *path
, char *buf
);
460 extern int save_stripes(int *source
, unsigned long long *offsets
,
461 int raid_disks
, int chunk_size
, int level
, int layout
,
462 int nwrites
, int *dest
,
463 unsigned long long start
, unsigned long long length
,
465 extern int restore_stripes(int *dest
, unsigned long long *offsets
,
466 int raid_disks
, int chunk_size
, int level
, int layout
,
467 int source
, unsigned long long read_offset
,
468 unsigned long long start
, unsigned long long length
);
471 #define Sendmail "/usr/lib/sendmail -t"
474 #define SYSLOG_FACILITY LOG_DAEMON
476 extern char *map_num(mapping_t
*map
, int num
);
477 extern int map_name(mapping_t
*map
, char *name
);
478 extern mapping_t r5layout
[], r6layout
[], pers
[], modes
[], faultylayout
[];
480 extern char *map_dev(int major
, int minor
, int create
);
483 struct metadata_update
;
485 /* A superswitch provides entry point the a metadata handler.
487 * The super_switch primarily operates on some "metadata" that
488 * is accessed via the 'supertype'.
489 * This metadata has one of three possible sources.
490 * 1/ It is read from a single device. In this case it may not completely
491 * describe the array or arrays as some information might be on other
493 * 2/ It is read from all devices in a container. In this case all
494 * information is present.
495 * 3/ It is created by ->init_super / ->add_to_super. In this case it will
496 * be complete once enough ->add_to_super calls have completed.
498 * When creating an array inside a container, the metadata will be
499 * formed by a combination of 2 and 3. The metadata or the array is read,
500 * then new information is added.
502 * The metadata must sometimes have a concept of a 'current' array
503 * and a 'current' device.
504 * The 'current' array is set by init_super to be the newly created array,
505 * or is set by super_by_fd when it finds it is looking at an array inside
508 * The 'current' device is either the device that the metadata was read from
509 * in case 1, or the last device added by add_to_super in case 3.
510 * Case 2 does not identify a 'current' device.
512 extern struct superswitch
{
514 /* Used to report details of metadata read from a component
515 * device. ->load_super has been called.
517 void (*examine_super
)(struct supertype
*st
, char *homehost
);
518 void (*brief_examine_super
)(struct supertype
*st
, int verbose
);
519 void (*brief_examine_subarrays
)(struct supertype
*st
, int verbose
);
520 void (*export_examine_super
)(struct supertype
*st
);
522 /* Used to report details of an active array.
523 * ->load_super was possibly given a 'component' string.
525 void (*detail_super
)(struct supertype
*st
, char *homehost
);
526 void (*brief_detail_super
)(struct supertype
*st
);
527 void (*export_detail_super
)(struct supertype
*st
);
529 /* Optional: platform hardware / firmware details */
530 int (*detail_platform
)(int verbose
, int enumerate_only
);
533 * to get uuid to storing in bitmap metadata
534 * and 'reshape' backup-data metadata
535 * To see if a device is being re-added to an array it was part of.
537 void (*uuid_from_super
)(struct supertype
*st
, int uuid
[4]);
539 /* Extract generic details from metadata. This could be details about
540 * the container, or about an individual array within the container.
541 * The determination is made either by:
542 * load_super being given a 'component' string.
543 * validate_geometry determining what to create.
544 * The info includes both array information and device information.
545 * The particular device should be:
546 * The last device added by add_to_super
547 * The device the metadata was loaded from by load_super
548 * If 'map' is present, then it is an array raid_disks long
549 * (raid_disk must already be set and correct) and it is filled
550 * with 1 for slots that are thought to be active and 0 for slots which
551 * appear to be failed/missing.
553 void (*getinfo_super
)(struct supertype
*st
, struct mdinfo
*info
, char *map
);
554 struct mdinfo
*(*getinfo_super_disks
)(struct supertype
*st
);
555 /* Check if the given metadata is flagged as belonging to "this"
556 * host. 0 for 'no', 1 for 'yes', -1 for "Don't record homehost"
558 int (*match_home
)(struct supertype
*st
, char *homehost
);
560 /* Make one of several generic modifications to metadata
561 * prior to assembly (or other times).
562 * sparc2.2 - first bug in early 0.90 metadata
563 * super-minor - change name of 0.90 metadata
564 * summaries - 'correct' any redundant data
565 * resync - mark array as dirty to trigger a resync.
566 * uuid - set new uuid - only 0.90 or 1.x
567 * name - change the name of the array (where supported)
568 * homehost - change which host this array is tied to.
569 * devicesize - If metadata is at start of device, change recorded
570 * device size to match actual device size
571 * byteorder - swap bytes for 0.90 metadata
573 * force-one - mark that device as uptodate, not old or failed.
574 * force-array - mark array as clean if it would not otherwise
576 * assemble - not sure how this is different from force-one...
577 * linear-grow-new - add a new device to a linear array, but don't
578 * change the size: so superblock still matches
579 * linear-grow-update - now change the size of the array.
581 int (*update_super
)(struct supertype
*st
, struct mdinfo
*info
,
583 char *devname
, int verbose
,
584 int uuid_set
, char *homehost
);
586 /* Create new metadata for new array as described. This could
587 * be a new container, or an array in a pre-existing container.
588 * Also used to zero metadata prior to writing it to invalidate old
591 int (*init_super
)(struct supertype
*st
, mdu_array_info_t
*info
,
592 unsigned long long size
, char *name
,
593 char *homehost
, int *uuid
);
595 /* update the metadata to include new device, either at create or
596 * when hot-adding a spare.
598 int (*add_to_super
)(struct supertype
*st
, mdu_disk_info_t
*dinfo
,
599 int fd
, char *devname
);
601 /* Write metadata to one device when fixing problems or adding
604 int (*store_super
)(struct supertype
*st
, int fd
);
606 /* Write all metadata for this array.
608 int (*write_init_super
)(struct supertype
*st
);
609 int (*compare_super
)(struct supertype
*st
, struct supertype
*tst
);
610 int (*load_super
)(struct supertype
*st
, int fd
, char *devname
);
611 int (*load_container
)(struct supertype
*st
, int fd
, char *devname
);
612 struct supertype
* (*match_metadata_desc
)(char *arg
);
613 __u64 (*avail_size
)(struct supertype
*st
, __u64 size
);
614 unsigned long long (*min_acceptable_spare_size
)(struct supertype
*st
);
615 int (*add_internal_bitmap
)(struct supertype
*st
, int *chunkp
,
616 int delay
, int write_behind
,
617 unsigned long long size
, int may_change
, int major
);
618 void (*locate_bitmap
)(struct supertype
*st
, int fd
);
619 int (*write_bitmap
)(struct supertype
*st
, int fd
);
620 void (*free_super
)(struct supertype
*st
);
622 /* validate_geometry is called with an st returned by
623 * match_metadata_desc.
624 * It should check that the geometry described in compatible with
625 * the metadata type. It will be called repeatedly as devices
626 * added to validate changing size and new devices. If there are
627 * inter-device dependencies, it should record sufficient details
628 * so these can be validated.
629 * Both 'size' and '*freesize' are in sectors. chunk is KiB.
631 int (*validate_geometry
)(struct supertype
*st
, int level
, int layout
,
633 int chunk
, unsigned long long size
,
634 char *subdev
, unsigned long long *freesize
,
637 struct mdinfo
*(*container_content
)(struct supertype
*st
, char *subarray
);
638 /* query the supertype for default geometry */
639 void (*default_geometry
)(struct supertype
*st
, int *level
, int *layout
, int *chunk
); /* optional */
640 /* Permit subarray's to be deleted from inactive containers */
641 int (*kill_subarray
)(struct supertype
*st
); /* optional */
642 /* Permit subarray's to be modified */
643 int (*update_subarray
)(struct supertype
*st
, char *subarray
,
644 char *update
, struct mddev_ident
*ident
); /* optional */
647 int (*open_new
)(struct supertype
*c
, struct active_array
*a
,
650 /* Tell the metadata handler the current state of the array.
651 * This covers whether it is known to be consistent (no pending writes)
652 * and how far along a resync is known to have progressed
653 * (in a->resync_start).
654 * resync status is really irrelevant if the array is not consistent,
655 * but some metadata (DDF!) have a place to record the distinction.
656 * If 'consistent' is '2', then the array can mark it dirty if a
657 * resync/recovery/whatever is required, or leave it clean if not.
658 * Return value is 0 dirty (not consistent) and 1 if clean.
659 * it is only really important if consistent is passed in as '2'.
661 int (*set_array_state
)(struct active_array
*a
, int consistent
);
663 /* When the state of a device might have changed, we call set_disk to
664 * tell the metadata what the current state is.
665 * Typically this happens on spare->in_sync and (spare|in_sync)->faulty
667 * set_disk might be called when the state of the particular disk has
668 * not in fact changed.
670 void (*set_disk
)(struct active_array
*a
, int n
, int state
);
671 void (*sync_metadata
)(struct supertype
*st
);
672 void (*process_update
)(struct supertype
*st
,
673 struct metadata_update
*update
);
674 void (*prepare_update
)(struct supertype
*st
,
675 struct metadata_update
*update
);
677 /* activate_spare will check if the array is degraded and, if it
678 * is, try to find some spare space in the container.
679 * On success, it add appropriate updates (For process_update) to
680 * to the 'updates' list and returns a list of 'mdinfo' identifying
681 * the device, or devices as there might be multiple missing
682 * devices and multiple spares available.
684 struct mdinfo
*(*activate_spare
)(struct active_array
*a
,
685 struct metadata_update
**updates
);
687 * Return statically allocated string that represents metadata specific
688 * controller domain of the disk. The domain is used in disk domain
689 * matching functions. Disks belong to the same domain if the they have
690 * the same domain from mdadm.conf and belong the same metadata domain.
691 * Returning NULL or not providing this handler means that metadata
692 * does not distinguish the differences between disks that belong to
693 * different controllers. They are in the domain specified by
694 * configuration file (mdadm.conf).
695 * In case when the metadata has the notion of domains based on disk
696 * it shall return NULL for disks that do not belong to the controller
697 * the supported domains. Such disks will form another domain and won't
698 * be mixed with supported ones.
700 const char *(*get_disk_controller_domain
)(const char *path
);
702 int swapuuid
; /* true if uuid is bigending rather than hostendian */
704 const char *name
; /* canonical metadata name */
707 extern struct superswitch super0
, super1
;
708 extern struct superswitch super_imsm
, super_ddf
;
709 extern struct superswitch mbr
, gpt
;
711 struct metadata_update
{
714 void *space
; /* allocated space that monitor will use */
715 struct metadata_update
*next
;
718 /* A supertype holds a particular collection of metadata.
719 * It identifies the metadata type by the superswitch, and the particular
720 * sub-version of that metadata type.
721 * metadata read in or created is stored in 'sb' and 'info'.
722 * There are also fields used by mdmon to track containers.
724 * A supertype may refer to:
725 * Just an array, possibly in a container
726 * A container, not identifying any particular array
727 * Info read from just one device, not yet fully describing the array/container.
730 * A supertype is created by:
736 struct superswitch
*ss
;
739 int container_dev
; /* devnum of container */
743 struct metadata_update
*updates
;
744 struct metadata_update
**update_tail
;
746 /* extra stuff used by mdmon */
747 struct active_array
*arrays
;
748 int sock
; /* listen to external programs */
750 char *devname
; /* e.g. md0. This appears in metadata_verison:
759 extern struct supertype
*super_by_fd(int fd
, char **subarray
);
760 enum guess_types
{ guess_any
, guess_array
, guess_partitions
};
761 extern struct supertype
*guess_super_type(int fd
, enum guess_types guess_type
);
762 static inline struct supertype
*guess_super(int fd
) {
763 return guess_super_type(fd
, guess_any
);
765 extern struct supertype
*dup_super(struct supertype
*st
);
766 extern int get_dev_size(int fd
, char *dname
, unsigned long long *sizep
);
767 extern int must_be_container(int fd
);
768 extern int dev_size_from_id(unsigned id
, unsigned long long *size
);
769 extern void get_one_disk(int mdfd
, mdu_array_info_t
*ainf
,
770 mdu_disk_info_t
*disk
);
771 void wait_for(char *dev
, int fd
);
774 * Data structures for policy management.
775 * Each device can have a policy structure that lists
776 * various name/value pairs each possibly with a metadata associated.
777 * The policy list is sorted by name/value/metadata
780 struct dev_policy
*next
;
781 char *name
; /* None of these strings are allocated. They are
782 * all just references to strings which are known
783 * to exist elsewhere.
784 * name and metadata can be compared by address equality.
786 const char *metadata
;
790 extern char pol_act
[], pol_domain
[], pol_metadata
[], pol_auto
[];
792 /* iterate over the sublist starting at list, having the same
793 * 'name' as 'list', and matching the given metadata (Where
794 * NULL matches anything
796 #define pol_for_each(item, list, _metadata) \
798 item && item->name == list->name; \
800 if (!(!_metadata || !item->metadata || _metadata == item->metadata)) \
804 * policy records read from mdadm are largely just name-value pairs.
805 * The names are constants, not strdupped
808 struct pol_rule
*next
;
809 char *type
; /* rule_policy or rule_part */
814 char *dups
; /* duplicates of 'value' with a partNN appended */
818 extern char rule_policy
[], rule_part
[];
819 extern char rule_path
[], rule_type
[];
820 extern char type_part
[], type_disk
[];
822 extern void policyline(char *line
, char *type
);
823 extern void policy_add(char *type
, ...);
824 extern void policy_free(void);
826 extern struct dev_policy
*path_policy(char *path
, char *type
);
827 extern struct dev_policy
*disk_policy(struct mdinfo
*disk
);
828 extern struct dev_policy
*devnum_policy(int dev
);
829 extern void dev_policy_free(struct dev_policy
*p
);
831 //extern void pol_new(struct dev_policy **pol, char *name, char *val, char *metadata);
832 extern void pol_add(struct dev_policy
**pol
, char *name
, char *val
, char *metadata
);
833 extern struct dev_policy
*pol_find(struct dev_policy
*pol
, char *name
);
839 act_spare
, /* This only applies to bare devices */
840 act_spare_same_slot
, /* this allows non-bare devices,
841 * but only if recent removal */
842 act_force_spare
, /* this allow non-bare devices in any case */
846 extern int policy_action_allows(struct dev_policy
*plist
, const char *metadata
,
847 enum policy_action want
);
848 extern int disk_action_allows(struct mdinfo
*disk
, const char *metadata
,
849 enum policy_action want
);
852 struct domainlist
*next
;
856 extern int domain_test(struct domainlist
*dom
, struct dev_policy
*pol
,
857 const char *metadata
);
858 extern struct domainlist
*domain_from_array(struct mdinfo
*mdi
,
859 const char *metadata
);
860 extern void domainlist_add_dev(struct domainlist
**dom
, int devnum
,
861 const char *metadata
);
862 extern void domain_free(struct domainlist
*dl
);
863 extern void domain_merge(struct domainlist
**domp
, struct dev_policy
*pol
,
864 const char *metadata
);
865 void domain_add(struct domainlist
**domp
, char *domain
);
867 extern void policy_save_path(char *id_path
, struct map_ent
*array
);
868 extern int policy_check_path(struct mdinfo
*disk
, struct map_ent
*array
);
874 #define HAVE_NFTW we assume
878 # include <features.h>
879 # ifndef __UCLIBC_HAS_LFS__
880 # define lseek64 lseek
882 # ifndef __UCLIBC_HAS_FTW__
892 #if defined(__KLIBC__)
908 extern int add_dev(const char *name
, const struct stat
*stb
, int flag
, struct FTW
*s
);
911 extern int Manage_ro(char *devname
, int fd
, int readonly
);
912 extern int Manage_runstop(char *devname
, int fd
, int runstop
, int quiet
);
913 extern int Manage_resize(char *devname
, int fd
, long long size
, int raid_disks
);
914 extern int Manage_subdevs(char *devname
, int fd
,
915 struct mddev_dev
*devlist
, int verbose
, int test
);
916 extern int autodetect(void);
917 extern int Grow_Add_device(char *devname
, int fd
, char *newdev
);
918 extern int Grow_addbitmap(char *devname
, int fd
, char *file
, int chunk
, int delay
, int write_behind
, int force
);
919 extern int Grow_reshape(char *devname
, int fd
, int quiet
, char *backup_file
,
921 int level
, char *layout_str
, int chunksize
, int raid_disks
);
922 extern int Grow_restart(struct supertype
*st
, struct mdinfo
*info
,
923 int *fdlist
, int cnt
, char *backup_file
, int verbose
);
924 extern int Grow_continue(int mdfd
, struct supertype
*st
,
925 struct mdinfo
*info
, char *backup_file
);
927 extern int Assemble(struct supertype
*st
, char *mddev
,
928 struct mddev_ident
*ident
,
929 struct mddev_dev
*devlist
, char *backup_file
,
930 int readonly
, int runstop
,
931 char *update
, char *homehost
, int require_homehost
,
932 int verbose
, int force
);
934 extern int Build(char *mddev
, int chunk
, int level
, int layout
,
935 int raiddisks
, struct mddev_dev
*devlist
, int assume_clean
,
936 char *bitmap_file
, int bitmap_chunk
, int write_behind
,
937 int delay
, int verbose
, int autof
, unsigned long long size
);
940 extern int Create(struct supertype
*st
, char *mddev
,
941 int chunk
, int level
, int layout
, unsigned long long size
, int raiddisks
, int sparedisks
,
942 char *name
, char *homehost
, int *uuid
,
943 int subdevs
, struct mddev_dev
*devlist
,
944 int runstop
, int verbose
, int force
, int assume_clean
,
945 char *bitmap_file
, int bitmap_chunk
, int write_behind
, int delay
, int autof
);
947 extern int Detail(char *dev
, int brief
, int export
, int test
, char *homehost
);
948 extern int Detail_Platform(struct superswitch
*ss
, int scan
, int verbose
);
949 extern int Query(char *dev
);
950 extern int Examine(struct mddev_dev
*devlist
, int brief
, int export
, int scan
,
951 int SparcAdjust
, struct supertype
*forcest
, char *homehost
);
952 extern int Monitor(struct mddev_dev
*devlist
,
953 char *mailaddr
, char *alert_cmd
,
954 int period
, int daemonise
, int scan
, int oneshot
,
955 int dosyslog
, int test
, char *pidfile
, int increments
,
958 extern int Kill(char *dev
, struct supertype
*st
, int force
, int quiet
, int noexcl
);
959 extern int Kill_subarray(char *dev
, char *subarray
, int quiet
);
960 extern int Update_subarray(char *dev
, char *subarray
, char *update
, struct mddev_ident
*ident
, int quiet
);
961 extern int Wait(char *dev
);
962 extern int WaitClean(char *dev
, int sock
, int verbose
);
964 extern int Incremental(char *devname
, int verbose
, int runstop
,
965 struct supertype
*st
, char *homehost
, int require_homehost
,
967 extern void RebuildMap(void);
968 extern int IncrementalScan(int verbose
);
969 extern int IncrementalRemove(char *devname
, char *path
, int verbose
);
970 extern int CreateBitmap(char *filename
, int force
, char uuid
[16],
971 unsigned long chunksize
, unsigned long daemon_sleep
,
972 unsigned long write_behind
,
973 unsigned long long array_size
,
975 extern int ExamineBitmap(char *filename
, int brief
, struct supertype
*st
);
976 extern int bitmap_update_uuid(int fd
, int *uuid
, int swap
);
977 extern unsigned long bitmap_sectors(struct bitmap_super_s
*bsb
);
979 extern int md_get_version(int fd
);
980 extern int get_linux_version(void);
981 extern int mdadm_version(char *version
);
982 extern long long parse_size(char *size
);
983 extern int parse_uuid(char *str
, int uuid
[4]);
984 extern int parse_layout_10(char *layout
);
985 extern int parse_layout_faulty(char *layout
);
986 extern int check_ext2(int fd
, char *name
);
987 extern int check_reiser(int fd
, char *name
);
988 extern int check_raid(int fd
, char *name
);
989 extern int check_partitions(int fd
, char *dname
, unsigned long long freesize
);
991 extern int get_mdp_major(void);
992 extern int dev_open(char *dev
, int flags
);
993 extern int open_dev(int devnum
);
994 extern int open_dev_excl(int devnum
);
995 extern int is_standard(char *dev
, int *nump
);
996 extern int same_dev(char *one
, char *two
);
998 extern int parse_auto(char *str
, char *msg
, int config
);
999 extern struct mddev_ident
*conf_get_ident(char *dev
);
1000 extern struct mddev_dev
*conf_get_devs(void);
1001 extern int conf_test_dev(char *devname
);
1002 extern int conf_test_metadata(const char *version
, struct dev_policy
*pol
, int is_homehost
);
1003 extern struct createinfo
*conf_get_create_info(void);
1004 extern void set_conffile(char *file
);
1005 extern char *conf_get_mailaddr(void);
1006 extern char *conf_get_mailfrom(void);
1007 extern char *conf_get_program(void);
1008 extern char *conf_get_homehost(int *require_homehostp
);
1009 extern char *conf_line(FILE *file
);
1010 extern char *conf_word(FILE *file
, int allow_key
);
1011 extern int conf_name_is_free(char *name
);
1012 extern int devname_matches(char *name
, char *match
);
1013 extern struct mddev_ident
*conf_match(struct mdinfo
*info
, struct supertype
*st
);
1015 extern void free_line(char *line
);
1016 extern int match_oneof(char *devices
, char *devname
);
1017 extern void uuid_from_super(int uuid
[4], mdp_super_t
*super
);
1018 extern const int uuid_match_any
[4];
1019 extern int same_uuid(int a
[4], int b
[4], int swapuuid
);
1020 extern void copy_uuid(void *a
, int b
[4], int swapuuid
);
1021 extern char *__fname_from_uuid(int id
[4], int swap
, char *buf
, char sep
);
1022 extern char *fname_from_uuid(struct supertype
*st
,
1023 struct mdinfo
*info
, char *buf
, char sep
);
1024 extern unsigned long calc_csum(void *super
, int bytes
);
1025 extern int enough(int level
, int raid_disks
, int layout
, int clean
,
1026 char *avail
, int avail_disks
);
1027 extern int enough_fd(int fd
);
1028 extern int ask(char *mesg
);
1029 extern unsigned long long get_component_size(int fd
);
1030 extern void remove_partitions(int fd
);
1031 extern int test_partition(int fd
);
1032 extern unsigned long long calc_array_size(int level
, int raid_disks
, int layout
,
1033 int chunksize
, unsigned long long devsize
);
1034 extern int flush_metadata_updates(struct supertype
*st
);
1035 extern void append_metadata_update(struct supertype
*st
, void *buf
, int len
);
1036 extern int assemble_container_content(struct supertype
*st
, int mdfd
,
1037 struct mdinfo
*content
, int runstop
,
1038 char *chosen_name
, int verbose
);
1040 extern int add_disk(int mdfd
, struct supertype
*st
,
1041 struct mdinfo
*sra
, struct mdinfo
*info
);
1042 extern int set_array_info(int mdfd
, struct supertype
*st
, struct mdinfo
*info
);
1043 unsigned long long min_recovery_start(struct mdinfo
*array
);
1045 extern char *human_size(long long bytes
);
1046 extern char *human_size_brief(long long bytes
);
1047 extern void print_r10_layout(int layout
);
1049 #define NoMdDev (1<<23)
1050 extern int find_free_devnum(int use_partitions
);
1052 extern void put_md_name(char *name
);
1053 extern char *get_md_name(int dev
);
1055 extern char DefaultConfFile
[];
1057 extern int create_mddev(char *dev
, char *name
, int autof
, int trustworthy
,
1059 /* values for 'trustworthy' */
1061 #define LOCAL_ANY 10
1064 extern int open_mddev(char *dev
, int report_errors
);
1065 extern int open_container(int fd
);
1066 extern int is_container_member(struct mdstat_ent
*ent
, char *devname
);
1067 extern int is_subarray_active(char *subarray
, char *devname
);
1068 int is_container_active(char *devname
);
1069 extern int open_subarray(char *dev
, char *subarray
, struct supertype
*st
, int quiet
);
1070 extern struct superswitch
*version_to_superswitch(char *vers
);
1072 extern int mdmon_running(int devnum
);
1073 extern int mdmon_pid(int devnum
);
1074 extern int check_env(char *name
);
1075 extern __u32
random32(void);
1076 extern int start_mdmon(int devnum
);
1078 extern char *devnum2devname(int num
);
1079 extern int devname2devnum(char *name
);
1080 extern int stat2devnum(struct stat
*st
);
1081 extern int fd2devnum(int fd
);
1083 static inline int dev2major(int d
)
1088 return get_mdp_major();
1091 static inline int dev2minor(int d
)
1095 return (-1-d
) << MdpMinorShift
;
1098 static inline int ROUND_UP(int a
, int base
)
1100 return ((a
+base
-1)/base
)*base
;
1103 static inline int is_subarray(char *vers
)
1105 /* The version string for a 'subarray' (an array in a container)
1107 * /containername/componentname for normal read-write arrays
1108 * -containername/componentname for read-only arrays.
1109 * containername is e.g. md0, md_d1
1110 * componentname is dependant on the metadata. e.g. '1' 'S1' ...
1112 return (*vers
== '/' || *vers
== '-');
1115 static inline char *to_subarray(struct mdstat_ent
*ent
, char *container
)
1117 return &ent
->metadata_version
[10+strlen(container
)+1];
1121 #define dprintf(fmt, arg...) \
1122 fprintf(stderr, fmt, ##arg)
1124 #define dprintf(fmt, arg...) \
1125 ({ if (0) fprintf(stderr, fmt, ##arg); 0; })
1129 static inline int xasprintf(char **strp
, const char *fmt
, ...) {
1133 ret
= vasprintf(strp
, fmt
, ap
);
1139 #define LEVEL_MULTIPATH (-4)
1140 #define LEVEL_LINEAR (-1)
1141 #define LEVEL_FAULTY (-5)
1143 /* kernel module doesn't know about these */
1144 #define LEVEL_CONTAINER (-100)
1145 #define LEVEL_UNSUPPORTED (-200)
1150 #define WriteTransient 0
1151 #define ReadTransient 1
1152 #define WritePersistent 2
1153 #define ReadPersistent 3
1154 #define WriteAll 4 /* doesn't go to device */
1155 #define ReadFixable 5
1158 #define ClearErrors 31
1159 #define ClearFaults 30
1161 #define AllPersist 100 /* internal use only */
1162 #define NoPersist 101
1164 #define ModeMask 0x1f
1172 #define minor(x) ((x)&0xff)
1173 #define major(x) (((x)>>8)&0xff)
1174 #define makedev(M,m) (((M)<<8) | (m))
1178 #define ALGORITHM_LEFT_ASYMMETRIC 0
1179 #define ALGORITHM_RIGHT_ASYMMETRIC 1
1180 #define ALGORITHM_LEFT_SYMMETRIC 2
1181 #define ALGORITHM_RIGHT_SYMMETRIC 3
1183 /* Define non-rotating (raid4) algorithms. These allow
1184 * conversion of raid4 to raid5.
1186 #define ALGORITHM_PARITY_0 4 /* P or P,Q are initial devices */
1187 #define ALGORITHM_PARITY_N 5 /* P or P,Q are final devices. */
1189 /* DDF RAID6 layouts differ from md/raid6 layouts in two ways.
1190 * Firstly, the exact positioning of the parity block is slightly
1191 * different between the 'LEFT_*' modes of md and the "_N_*" modes
1193 * Secondly, or order of datablocks over which the Q syndrome is computed
1195 * Consequently we have different layouts for DDF/raid6 than md/raid6.
1196 * These layouts are from the DDFv1.2 spec.
1197 * Interestingly DDFv1.2-Errata-A does not specify N_CONTINUE but
1198 * leaves RLQ=3 as 'Vendor Specific'
1201 #define ALGORITHM_ROTATING_ZERO_RESTART 8 /* DDF PRL=6 RLQ=1 */
1202 #define ALGORITHM_ROTATING_N_RESTART 9 /* DDF PRL=6 RLQ=2 */
1203 #define ALGORITHM_ROTATING_N_CONTINUE 10 /*DDF PRL=6 RLQ=3 */
1206 /* For every RAID5 algorithm we define a RAID6 algorithm
1207 * with exactly the same layout for data and parity, and
1208 * with the Q block always on the last device (N-1).
1209 * This allows trivial conversion from RAID5 to RAID6
1211 #define ALGORITHM_LEFT_ASYMMETRIC_6 16
1212 #define ALGORITHM_RIGHT_ASYMMETRIC_6 17
1213 #define ALGORITHM_LEFT_SYMMETRIC_6 18
1214 #define ALGORITHM_RIGHT_SYMMETRIC_6 19
1215 #define ALGORITHM_PARITY_0_6 20
1216 #define ALGORITHM_PARITY_N_6 ALGORITHM_PARITY_N
1218 /* Define PATH_MAX in case we don't use glibc or standard library does
1219 * not have PATH_MAX defined. Assume max path length is 4K characters.
1222 #define PATH_MAX 4096