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
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
37 #include <sys/types.h>
52 /* Newer glibc requires sys/sysmacros.h directly for makedev() */
53 #include <sys/sysmacros.h>
56 /* dietlibc has deprecated random and srandom!! */
63 typedef uint64_t cmap_handle_t
;
65 #include <corosync/cmap.h>
72 #define LKF_NOQUEUE 0x00000001
74 #define EUNLOCK 0x10002
76 typedef void *dlm_lshandle_t
;
86 #include <linux/kdev_t.h>
87 /*#include <linux/fs.h> */
88 #include <sys/mount.h>
89 #include <asm/types.h>
90 #include <sys/ioctl.h>
92 #define MdpMinorShift 6
95 #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
98 #define DEFAULT_CHUNK 512
99 #define DEFAULT_BITMAP_CHUNK 4096
100 #define DEFAULT_BITMAP_DELAY 5
101 #define DEFAULT_MAX_WRITE_BEHIND 256
103 /* DEV_NUM_PREF is a subpath to numbered MD devices, e.g. /dev/md1 or directory name.
104 * DEV_NUM_PREF_LEN is a length with Null byte excluded.
107 #define DEV_NUM_PREF "/dev/md"
108 #define DEV_NUM_PREF_LEN (sizeof(DEV_NUM_PREF) - 1)
109 #endif /* DEV_NUM_PREF */
111 /* DEV_MD_DIR points to named MD devices directory.
112 * DEV_MD_DIR_LEN is a length with Null byte excluded.
115 #define DEV_MD_DIR "/dev/md/"
116 #define DEV_MD_DIR_LEN (sizeof(DEV_MD_DIR) - 1)
117 #endif /* DEV_MD_DIR */
119 /* MAP_DIR should be somewhere that persists across the pivotroot
120 * from early boot to late boot.
121 * /run seems to have emerged as the best standard.
124 #define MAP_DIR "/run/mdadm"
126 /* MAP_FILE is what we name the map file we put in MAP_DIR, in case you
127 * want something other than the default of "map"
130 #define MAP_FILE "map"
131 #endif /* MAP_FILE */
132 /* MDMON_DIR is where pid and socket files used for communicating
133 * with mdmon normally live. Best is /var/run/mdadm as
134 * mdmon is needed at early boot then it needs to write there prior
135 * to /var/run being mounted read/write, and it also then needs to
136 * persist beyond when /var/run is mounter read-only. So, to be
137 * safe, the default is somewhere that is read/write early in the
138 * boot process and stays up as long as possible during shutdown.
141 #define MDMON_DIR "/run/mdadm"
142 #endif /* MDMON_DIR */
144 /* FAILED_SLOTS is where to save files storing recent removal of array
145 * member in order to allow future reuse of disk inserted in the same
146 * slot for array recovery
148 #ifndef FAILED_SLOTS_DIR
149 #define FAILED_SLOTS_DIR "/run/mdadm/failed-slots"
150 #endif /* FAILED_SLOTS */
152 #ifndef MDMON_SERVICE
153 #define MDMON_SERVICE "mdmon"
154 #endif /* MDMON_SERVICE */
157 #define GROW_SERVICE "mdadm-grow-continue"
158 #endif /* GROW_SERVICE */
166 /* Redhat don't like to #include <asm/byteorder.h>, and
167 * some time include <linux/byteorder/xxx_endian.h> isn't enough,
168 * and there is no standard conversion function so... */
169 /* And dietlibc doesn't think byteswap is ok, so.. */
170 /* #include <byteswap.h> */
171 #define __mdadm_bswap_16(x) (((x) & 0x00ffU) << 8 | \
172 ((x) & 0xff00U) >> 8)
173 #define __mdadm_bswap_32(x) (((x) & 0x000000ffU) << 24 | \
174 ((x) & 0xff000000U) >> 24 | \
175 ((x) & 0x0000ff00U) << 8 | \
176 ((x) & 0x00ff0000U) >> 8)
177 #define __mdadm_bswap_64(x) (((x) & 0x00000000000000ffULL) << 56 | \
178 ((x) & 0xff00000000000000ULL) >> 56 | \
179 ((x) & 0x000000000000ff00ULL) << 40 | \
180 ((x) & 0x00ff000000000000ULL) >> 40 | \
181 ((x) & 0x0000000000ff0000ULL) << 24 | \
182 ((x) & 0x0000ff0000000000ULL) >> 24 | \
183 ((x) & 0x00000000ff000000ULL) << 8 | \
184 ((x) & 0x000000ff00000000ULL) >> 8)
186 #if !defined(__KLIBC__)
187 #if BYTE_ORDER == LITTLE_ENDIAN
188 #define __cpu_to_le16(_x) (unsigned int)(_x)
189 #define __cpu_to_le32(_x) (unsigned int)(_x)
190 #define __cpu_to_le64(_x) (unsigned long long)(_x)
191 #define __le16_to_cpu(_x) (unsigned int)(_x)
192 #define __le32_to_cpu(_x) (unsigned int)(_x)
193 #define __le64_to_cpu(_x) (unsigned long long)(_x)
195 #define __cpu_to_be16(_x) __mdadm_bswap_16(_x)
196 #define __cpu_to_be32(_x) __mdadm_bswap_32(_x)
197 #define __cpu_to_be64(_x) __mdadm_bswap_64(_x)
198 #define __be16_to_cpu(_x) __mdadm_bswap_16(_x)
199 #define __be32_to_cpu(_x) __mdadm_bswap_32(_x)
200 #define __be64_to_cpu(_x) __mdadm_bswap_64(_x)
201 #elif BYTE_ORDER == BIG_ENDIAN
202 #define __cpu_to_le16(_x) __mdadm_bswap_16(_x)
203 #define __cpu_to_le32(_x) __mdadm_bswap_32(_x)
204 #define __cpu_to_le64(_x) __mdadm_bswap_64(_x)
205 #define __le16_to_cpu(_x) __mdadm_bswap_16(_x)
206 #define __le32_to_cpu(_x) __mdadm_bswap_32(_x)
207 #define __le64_to_cpu(_x) __mdadm_bswap_64(_x)
209 #define __cpu_to_be16(_x) (unsigned int)(_x)
210 #define __cpu_to_be32(_x) (unsigned int)(_x)
211 #define __cpu_to_be64(_x) (unsigned long long)(_x)
212 #define __be16_to_cpu(_x) (unsigned int)(_x)
213 #define __be32_to_cpu(_x) (unsigned int)(_x)
214 #define __be64_to_cpu(_x) (unsigned long long)(_x)
216 # error "unknown endianness."
218 #endif /* __KLIBC__ */
221 * Partially stolen from include/linux/unaligned/packed_struct.h
223 struct __una_u16
{ __u16 x
; } __attribute__ ((packed
));
224 struct __una_u32
{ __u32 x
; } __attribute__ ((packed
));
226 static inline __u16
__get_unaligned16(const void *p
)
228 const struct __una_u16
*ptr
= (const struct __una_u16
*)p
;
232 static inline __u32
__get_unaligned32(const void *p
)
234 const struct __una_u32
*ptr
= (const struct __una_u32
*)p
;
238 static inline void __put_unaligned16(__u16 val
, void *p
)
240 struct __una_u16
*ptr
= (struct __una_u16
*)p
;
244 static inline void __put_unaligned32(__u32 val
, void *p
)
246 struct __una_u32
*ptr
= (struct __una_u32
*)p
;
251 * Check at compile time that something is of a particular type.
252 * Always evaluates to 1 so you may use it easily in comparisons.
255 #define typecheck(type,x) \
257 typeof(x) __dummy2; \
258 (void)(&__dummy == &__dummy2); \
263 * These inlines deal with timer wrapping correctly.
265 * time_after(a,b) returns true if the time a is after time b.
268 #define time_after(a,b) \
269 (typecheck(unsigned int, a) && \
270 typecheck(unsigned int, b) && \
271 ((int)((b) - (a)) < 0))
273 #define time_before(a,b) time_after(b,a)
276 * min()/max()/clamp() macros that also do
277 * strict type-checking.. See the
278 * "unnecessary" pointer comparison.
280 #define min(x, y) ({ \
281 typeof(x) _min1 = (x); \
282 typeof(y) _min2 = (y); \
283 (void) (&_min1 == &_min2); \
284 _min1 < _min2 ? _min1 : _min2; })
286 #define max(x, y) ({ \
287 typeof(x) _max1 = (x); \
288 typeof(y) _max2 = (y); \
289 (void) (&_max1 == &_max2); \
290 _max1 > _max2 ? _max1 : _max2; })
292 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
294 #define KIB_TO_BYTES(x) ((x) << 10)
295 #define SEC_TO_BYTES(x) ((x) << 9)
298 * This is true for native and DDF, IMSM allows 16.
300 #define MD_NAME_MAX 32
302 extern const char Name
[];
305 unsigned long long sector
;
312 struct md_bb_entry
*entries
;
315 /* general information that might be extracted from a superblock */
317 mdu_array_info_t array
;
318 mdu_disk_info_t disk
;
322 unsigned long long data_offset
;
323 unsigned long long new_data_offset
;
324 unsigned long long component_size
; /* same as array.size, except in
325 * sectors and up to 64bits.
327 unsigned long long custom_array_size
; /* size for non-default sized
328 * arrays (in sectors)
331 #define VOLUME_RESHAPE 1
332 #define CONTAINER_RESHAPE 2
333 #define RESHAPE_NO_BACKUP 16 /* Mask 'or'ed in */
335 unsigned long long reshape_progress
;
336 int recovery_blocked
; /* for external metadata it
337 * indicates that there is
338 * reshape in progress in
340 * for native metadata it is
341 * reshape_active field mirror
343 int journal_device_required
;
347 CONSISTENCY_POLICY_UNKNOWN
,
348 CONSISTENCY_POLICY_NONE
,
349 CONSISTENCY_POLICY_RESYNC
,
350 CONSISTENCY_POLICY_BITMAP
,
351 CONSISTENCY_POLICY_JOURNAL
,
352 CONSISTENCY_POLICY_PPL
,
353 } consistency_policy
;
355 /* During reshape we can sometimes change the data_offset to avoid
356 * over-writing still-valid data. We need to know if there is space.
357 * So getinfo_super will fill in space_before and space_after in sectors.
358 * data_offset can be increased or decreased by this amount.
360 unsigned long long space_before
, space_after
;
362 unsigned long long resync_start
; /* per-array resync position */
363 unsigned long long recovery_start
; /* per-device rebuild position */
364 #define MaxSector (~0ULL) /* resync/recovery complete position */
366 long bitmap_offset
; /* 0 == none, 1 == a file */
367 unsigned int ppl_size
;
369 unsigned long long ppl_sector
;
370 unsigned long safe_mode_delay
; /* ms delay to mark clean */
371 int new_level
, delta_disks
, new_layout
, new_chunk
;
373 unsigned long cache_size
; /* size of raid456 stripe cache*/
375 char text_version
[50];
377 int container_member
; /* for assembling external-metatdata arrays
378 * This is to be used internally by metadata
381 * flag external handlers can set to indicate that subarrays have:
382 * - not enough disks to start (-1),
383 * - enough disks to start (0),
384 * - all expected disks (1).
386 int container_enough
;
391 /* Device info for mdmon: */
398 #define DS_WRITE_MOSTLY 4
400 #define DS_BLOCKED 16
401 #define DS_REMOVE 1024
402 #define DS_UNBLOCK 2048
403 int prev_state
, curr_state
, next_state
;
405 /* info read from sysfs */
429 struct supertype
*supertype
;
432 struct spare_criteria
{
434 unsigned long long min_size
;
435 unsigned int sector_size
;
436 struct dev_policy
*pols
;
439 typedef enum mdadm_status
{
440 MDADM_STATUS_SUCCESS
= 0,
458 extern char short_options
[];
459 extern char short_monitor_options
[];
460 extern char short_bitmap_options
[];
461 extern char short_bitmap_auto_options
[];
462 extern struct option long_options
[];
463 extern char Version
[], Usage
[], Help
[], OptionHelp
[],
465 Help_create
[], Help_build
[], Help_assemble
[], Help_grow
[],
467 Help_manage
[], Help_misc
[], Help_monitor
[], Help_config
[];
469 /* for option that don't have short equivilents, we assign arbitrary
470 * numbers later than any 'short' character option.
472 enum special_options
{
558 UOPT_LAYOUT_ORIGINAL
,
559 UOPT_LAYOUT_ALTERNATE
,
560 UOPT_LAYOUT_UNSPECIFIED
,
565 * Code specific options, cannot be set by the user
568 UOPT_SPEC_FORCE_ARRAY
,
570 UOPT_SPEC_LINEAR_GROW_NEW
,
571 UOPT_SPEC_LINEAR_GROW_UPDATE
,
572 UOPT_SPEC__RESHAPE_PROGRESS
,
573 UOPT_SPEC_WRITEMOSTLY
,
576 UOPT_SPEC_NOFAILFAST
,
577 UOPT_SPEC_REVERT_RESHAPE_NOBACKUP
,
580 extern void fprint_update_options(FILE *outf
, enum update_opt update_mode
);
582 enum prefix_standard
{
594 FlagDefault
, FlagSet
, FlagClear
,
598 ROLLBACK_METADATA_CHANGES
,
599 APPLY_METADATA_CHANGES
602 /* structures read from config file */
603 /* List of mddevice names and identifiers
604 * Identifiers can be:
606 * super-minor=decimal-minor-number-from-superblock
607 * devices=comma,separated,list,of,device,names,with,wildcards
609 * If multiple fields are present, the intersection of all matching
610 * devices is considered
612 #define UnSet (0xfffe)
618 char name
[MD_NAME_MAX
+ 1];
622 char *devices
; /* comma separated list of device
623 * names with wild cards
628 struct supertype
*st
;
629 int autof
; /* 1 for normal, 2 for partitioned */
634 char *container
; /* /dev/whatever name of container, or
635 * uuid of container. You would expect
636 * this to be the 'devname' or UUID
637 * of some other entry.
639 char *member
; /* subarray within a container */
641 struct mddev_ident
*next
;
643 /* fields needed by different users of this structure */
644 int assembled
; /* set when assembly succeeds */
656 int require_homehost
;
661 enum update_opt update
;
689 unsigned long long size
;
690 unsigned long long data_offset
;
691 int consistency_policy
;
692 change_dir_t direction
;
695 /* List of device names - wildcards expanded */
698 int disposition
; /* 'a' for add, 'r' for remove, 'f' for fail,
700 * Not set for names read from .config
702 enum flag_mode writemostly
;
703 enum flag_mode failfast
;
704 int used
; /* set when used */
705 long long data_offset
;
706 struct mddev_dev
*next
;
709 typedef struct mapping
{
718 char *pattern
; /* U for up, _ for down */
719 int percent
; /* -1 if no resync */
720 int resync
; /* 3 if check, 2 if reshape, 1 if resync, 0 if recovery */
723 char * metadata_version
;
726 struct dev_member
*next
;
728 struct mdstat_ent
*next
;
731 extern struct mdstat_ent
*mdstat_read(int hold
, int start
);
732 extern void mdstat_close(void);
733 extern void free_mdstat(struct mdstat_ent
*ms
);
734 extern int mdstat_wait(int seconds
);
735 extern void mdstat_wait_fd(int fd
, const sigset_t
*sigmask
);
736 extern int mddev_busy(char *devnm
);
737 extern struct mdstat_ent
*mdstat_by_component(char *name
);
738 extern struct mdstat_ent
*mdstat_by_subdev(char *subdev
, char *container
);
741 struct map_ent
*next
;
748 extern int map_update(struct map_ent
**mpp
, char *devnm
, char *metadata
,
749 int uuid
[4], char *path
);
750 extern void map_remove(struct map_ent
**map
, char *devnm
);
751 extern struct map_ent
*map_by_uuid(struct map_ent
**map
, int uuid
[4]);
752 extern struct map_ent
*map_by_devnm(struct map_ent
**map
, char *devnm
);
753 extern void map_free(struct map_ent
*map
);
754 extern struct map_ent
*map_by_name(struct map_ent
**map
, char *name
);
755 extern void map_read(struct map_ent
**melp
);
756 extern int map_write(struct map_ent
*mel
);
757 extern void map_delete(struct map_ent
**mapp
, char *devnm
);
758 extern void map_add(struct map_ent
**melp
,
759 char *devnm
, char *metadata
, int uuid
[4], char *path
);
760 extern int map_lock(struct map_ent
**melp
);
761 extern void map_unlock(struct map_ent
**melp
);
762 extern void map_fork(void);
764 /* various details can be requested */
765 enum sysfs_read_flags
{
766 GET_LEVEL
= (1 << 0),
767 GET_LAYOUT
= (1 << 1),
768 GET_COMPONENT
= (1 << 2),
769 GET_CHUNK
= (1 << 3),
770 GET_CACHE
= (1 << 4),
771 GET_MISMATCH
= (1 << 5),
772 GET_VERSION
= (1 << 6),
773 GET_DISKS
= (1 << 7),
774 GET_SAFEMODE
= (1 << 9),
775 GET_BITMAP_LOCATION
= (1 << 10),
777 GET_DEVS
= (1 << 20), /* gets role, major, minor */
778 GET_OFFSET
= (1 << 21),
779 GET_SIZE
= (1 << 22),
780 GET_STATE
= (1 << 23),
781 GET_ERROR
= (1 << 24),
782 GET_ARRAY_STATE
= (1 << 25),
783 GET_CONSISTENCY_POLICY
= (1 << 26),
784 GET_DEVS_ALL
= (1 << 27),
787 #define SYSFS_MAX_BUF_SIZE 64
789 extern void sysfs_get_container_devnm(struct mdinfo
*mdi
, char *buf
);
791 /* If fd >= 0, get the array it is open on,
794 extern int sysfs_open(char *devnm
, char *devname
, char *attr
);
795 extern int sysfs_init(struct mdinfo
*mdi
, int fd
, char *devnm
);
796 extern void sysfs_init_dev(struct mdinfo
*mdi
, dev_t devid
);
797 extern void sysfs_free(struct mdinfo
*sra
);
798 extern struct mdinfo
*sysfs_read(int fd
, char *devnm
, unsigned long options
);
799 extern int sysfs_attr_match(const char *attr
, const char *str
);
800 extern int sysfs_match_word(const char *word
, char **list
);
801 extern int sysfs_set_str(struct mdinfo
*sra
, struct mdinfo
*dev
,
802 char *name
, char *val
);
803 extern int sysfs_set_num(struct mdinfo
*sra
, struct mdinfo
*dev
,
804 char *name
, unsigned long long val
);
805 extern int sysfs_set_num_signed(struct mdinfo
*sra
, struct mdinfo
*dev
,
806 char *name
, long long val
);
807 extern int sysfs_uevent(struct mdinfo
*sra
, char *event
);
808 extern int sysfs_get_fd(struct mdinfo
*sra
, struct mdinfo
*dev
,
810 extern int sysfs_fd_get_ll(int fd
, unsigned long long *val
);
811 extern int sysfs_get_ll(struct mdinfo
*sra
, struct mdinfo
*dev
,
812 char *name
, unsigned long long *val
);
813 extern int sysfs_fd_get_two(int fd
, unsigned long long *v1
, unsigned long long *v2
);
814 extern int sysfs_get_two(struct mdinfo
*sra
, struct mdinfo
*dev
,
815 char *name
, unsigned long long *v1
, unsigned long long *v2
);
816 extern int sysfs_fd_get_str(int fd
, char *val
, int size
);
817 extern int sysfs_attribute_available(struct mdinfo
*sra
, struct mdinfo
*dev
,
819 extern int sysfs_get_str(struct mdinfo
*sra
, struct mdinfo
*dev
,
820 char *name
, char *val
, int size
);
821 extern int sysfs_set_safemode(struct mdinfo
*sra
, unsigned long ms
);
822 extern int sysfs_set_array(struct mdinfo
*info
);
823 extern int sysfs_add_disk(struct mdinfo
*sra
, struct mdinfo
*sd
, int resume
);
824 extern int sysfs_disk_to_scsi_id(int fd
, __u32
*id
);
825 extern int sysfs_unique_holder(char *devnm
, long rdev
);
826 extern int sysfs_freeze_array(struct mdinfo
*sra
);
827 extern int sysfs_wait(int fd
, int *msec
);
828 extern int load_sys(char *path
, char *buf
, int len
);
829 extern int zero_disk_range(int fd
, unsigned long long sector
, size_t count
);
830 extern int reshape_prepare_fdlist(char *devname
,
834 unsigned long blocks
,
837 unsigned long long *offsets
);
838 extern void reshape_free_fdlist(int *fdlist
,
839 unsigned long long *offsets
,
841 extern int reshape_open_backup_file(char *backup
,
846 unsigned long long *offsets
,
849 extern unsigned long compute_backup_blocks(int nchunk
, int ochunk
,
850 unsigned int ndata
, unsigned int odata
);
851 extern char *locate_backup(char *name
);
852 extern char *make_backup(char *name
);
854 extern int save_stripes(int *source
, unsigned long long *offsets
,
855 int raid_disks
, int chunk_size
, int level
, int layout
,
856 int nwrites
, int *dest
,
857 unsigned long long start
, unsigned long long length
,
859 extern int restore_stripes(int *dest
, unsigned long long *offsets
,
860 int raid_disks
, int chunk_size
, int level
, int layout
,
861 int source
, unsigned long long read_offset
,
862 unsigned long long start
, unsigned long long length
,
864 extern bool sysfs_is_libata_allow_tpm_enabled(const int verbose
);
867 #define Sendmail "/usr/lib/sendmail -t"
870 #define SYSLOG_FACILITY LOG_DAEMON
871 extern char *map_num_s(mapping_t
*map
, int num
);
872 extern char *map_num(mapping_t
*map
, int num
);
873 extern int map_name(mapping_t
*map
, char *name
);
874 extern mapping_t r0layout
[], r5layout
[], r6layout
[],
875 pers
[], modes
[], faultylayout
[];
876 extern mapping_t consistency_policies
[], sysfs_array_states
[], update_options
[];
878 extern char *map_dev_preferred(int major
, int minor
, int create
,
880 static inline char *map_dev(int major
, int minor
, int create
)
882 return map_dev_preferred(major
, minor
, create
, NULL
);
886 * is_fd_valid() - check file descriptor.
887 * @fd: file descriptor.
889 * The function checks if @fd is nonnegative integer and shall be used only
890 * to verify open() result.
892 static inline int is_fd_valid(int fd
)
898 * is_level456() - check whether given level is between inclusive 4 and 6.
899 * @level: level to check.
901 * Return: true if condition is met, false otherwise
903 static inline bool is_level456(int level
)
905 return (level
>= 4 && level
<= 6);
909 * close_fd() - verify, close and unset file descriptor.
910 * @fd: pointer to file descriptor.
912 * The function closes and invalidates file descriptor if appropriative. It
913 * ignores incorrect file descriptor quitely to simplify error handling.
915 static inline void close_fd(int *fd
)
917 if (is_fd_valid(*fd
) && close(*fd
) == 0)
922 struct metadata_update
;
924 /* 'struct reshape' records the intermediate states of
926 * The starting geometry is converted to the 'before' geometry
927 * by at most an atomic level change. They could be the same.
928 * Similarly the 'after' geometry is converted to the final
929 * geometry by at most a level change.
930 * Note that 'before' and 'after' must have the same level.
931 * 'blocks' is the minimum number of sectors for a reshape unit.
932 * This will be a multiple of the stripe size in each of the
933 * 'before' and 'after' geometries.
934 * If 'blocks' is 0, no restriping is necessary.
935 * 'min_offset_change' is the minimum change to data_offset to
936 * allow the reshape to happen. It is at least the larger of
937 * the old and new chunk sizes, and typically the same as 'blocks'
938 * divided by number of data disks.
942 int parity
; /* number of parity blocks/devices */
947 unsigned long long backup_blocks
;
948 unsigned long long min_offset_change
;
949 unsigned long long stripes
; /* number of old stripes that comprise 'blocks'*/
950 unsigned long long new_size
; /* New size of array in sectors */
954 * struct dev_policy - Data structure for policy management.
955 * @next: pointer to next dev_policy.
956 * @name: policy name, category.
957 * @metadata: the metadata type it affects.
958 * @value: value of the policy.
960 * The functions to manipulate dev_policy lists do not free elements, so they must be statically
961 * allocated. @name and @metadata can be compared by address.
963 typedef struct dev_policy
{
964 struct dev_policy
*next
;
966 const char *metadata
;
970 /* A superswitch provides entry point to a metadata handler.
972 * The superswitch primarily operates on some "metadata" that
973 * is accessed via the 'supertype'.
974 * This metadata has one of three possible sources.
975 * 1/ It is read from a single device. In this case it may not completely
976 * describe the array or arrays as some information might be on other
978 * 2/ It is read from all devices in a container. In this case all
979 * information is present.
980 * 3/ It is created by ->init_super / ->add_to_super. In this case it will
981 * be complete once enough ->add_to_super calls have completed.
983 * When creating an array inside a container, the metadata will be
984 * formed by a combination of 2 and 3. The metadata or the array is read,
985 * then new information is added.
987 * The metadata must sometimes have a concept of a 'current' array
988 * and a 'current' device.
989 * The 'current' array is set by init_super to be the newly created array,
990 * or is set by super_by_fd when it finds it is looking at an array inside
993 * The 'current' device is either the device that the metadata was read from
994 * in case 1, or the last device added by add_to_super in case 3.
995 * Case 2 does not identify a 'current' device.
997 extern struct superswitch
{
999 /* Used to report details of metadata read from a component
1000 * device. ->load_super has been called.
1002 void (*examine_super
)(struct supertype
*st
, char *homehost
);
1003 void (*brief_examine_super
)(struct supertype
*st
, int verbose
);
1004 void (*brief_examine_subarrays
)(struct supertype
*st
, int verbose
);
1005 void (*export_examine_super
)(struct supertype
*st
);
1006 int (*examine_badblocks
)(struct supertype
*st
, int fd
, char *devname
);
1007 int (*copy_metadata
)(struct supertype
*st
, int from
, int to
);
1009 /* Used to report details of an active array.
1010 * ->load_super was possibly given a 'component' string.
1012 void (*detail_super
)(struct supertype
*st
, char *homehost
,
1014 void (*brief_detail_super
)(struct supertype
*st
, char *subarray
);
1015 void (*export_detail_super
)(struct supertype
*st
);
1017 /* Optional: platform hardware / firmware details */
1018 int (*detail_platform
)(int verbose
, int enumerate_only
, char *controller_path
);
1019 int (*export_detail_platform
)(int verbose
, char *controller_path
);
1022 * to get uuid to storing in bitmap metadata
1023 * and 'reshape' backup-data metadata
1024 * To see if a device is being re-added to an array it was part of.
1026 void (*uuid_from_super
)(struct supertype
*st
, int uuid
[4]);
1028 /* Extract generic details from metadata. This could be details about
1029 * the container, or about an individual array within the container.
1030 * The determination is made either by:
1031 * load_super being given a 'component' string.
1032 * validate_geometry determining what to create.
1033 * The info includes both array information and device information.
1034 * The particular device should be:
1035 * The last device added by add_to_super
1036 * The device the metadata was loaded from by load_super
1037 * If 'map' is present, then it is an array raid_disks long
1038 * (raid_disk must already be set and correct) and it is filled
1039 * with 1 for slots that are thought to be active and 0 for slots which
1040 * appear to be failed/missing.
1041 * *info is zeroed out before data is added.
1043 void (*getinfo_super
)(struct supertype
*st
, struct mdinfo
*info
, char *map
);
1044 struct mdinfo
*(*getinfo_super_disks
)(struct supertype
*st
);
1045 /* Check if the given metadata is flagged as belonging to "this"
1046 * host. 0 for 'no', 1 for 'yes', -1 for "Don't record homehost"
1048 int (*match_home
)(struct supertype
*st
, char *homehost
);
1050 /* Make one of several generic modifications to metadata
1051 * prior to assembly (or other times).
1052 * sparc2.2 - first bug in early 0.90 metadata
1053 * super-minor - change name of 0.90 metadata
1054 * summaries - 'correct' any redundant data
1055 * resync - mark array as dirty to trigger a resync.
1056 * uuid - set new uuid - only 0.90 or 1.x
1057 * name - change the name of the array (where supported)
1058 * homehost - change which host this array is tied to.
1059 * devicesize - If metadata is at start of device, change recorded
1060 * device size to match actual device size
1061 * byteorder - swap bytes for 0.90 metadata
1063 * force-one - mark that device as uptodate, not old or failed.
1064 * force-array - mark array as clean if it would not otherwise
1066 * assemble - not sure how this is different from force-one...
1067 * linear-grow-new - add a new device to a linear array, but don't
1068 * change the size: so superblock still matches
1069 * linear-grow-update - now change the size of the array.
1070 * writemostly - set the WriteMostly1 bit in the superblock devflags
1071 * readwrite - clear the WriteMostly1 bit in the superblock devflags
1072 * failfast - set the FailFast1 bit in the superblock
1073 * nofailfast - clear the FailFast1 bit
1074 * no-bitmap - clear any record that a bitmap is present.
1075 * bbl - add a bad-block-log if possible
1076 * no-bbl - remove any bad-block-log is it is empty.
1077 * force-no-bbl - remove any bad-block-log even if empty.
1078 * revert-reshape - If a reshape is in progress, modify metadata so
1079 * it will resume going in the opposite direction.
1081 int (*update_super
)(struct supertype
*st
, struct mdinfo
*info
,
1082 enum update_opt update
,
1083 char *devname
, int verbose
,
1084 int uuid_set
, char *homehost
);
1086 /* Create new metadata for new array as described. This could
1087 * be a new container, or an array in a pre-existing container.
1088 * Also used to zero metadata prior to writing it to invalidate old
1091 int (*init_super
)(struct supertype
*st
, mdu_array_info_t
*info
,
1092 struct shape
*s
, char *name
,
1093 char *homehost
, int *uuid
,
1094 unsigned long long data_offset
);
1096 /* update the metadata to include new device, either at create or
1097 * when hot-adding a spare.
1099 int (*add_to_super
)(struct supertype
*st
, mdu_disk_info_t
*dinfo
,
1100 int fd
, char *devname
,
1101 unsigned long long data_offset
);
1102 /* update the metadata to delete a device,
1103 * when hot-removing.
1105 int (*remove_from_super
)(struct supertype
*st
, mdu_disk_info_t
*dinfo
);
1107 /* Write metadata to one device when fixing problems or adding
1110 int (*store_super
)(struct supertype
*st
, int fd
);
1112 /* Write all metadata for this array.
1114 int (*write_init_super
)(struct supertype
*st
);
1115 /* Check if metadata read from one device is compatible with an array,
1116 * used when assembling an array, or pseudo-assembling was with
1117 * "--examine --brief"
1118 * If "st" has not yet been loaded the superblock from, "tst" is
1119 * moved in, otherwise the superblock in 'st' is compared with
1122 int (*compare_super
)(struct supertype
*st
, struct supertype
*tst
,
1124 /* Load metadata from a single device. If 'devname' is not NULL
1125 * print error messages as appropriate */
1126 int (*load_super
)(struct supertype
*st
, int fd
, char *devname
);
1127 /* 'fd' is a 'container' md array - load array metadata from the
1130 int (*load_container
)(struct supertype
*st
, int fd
, char *devname
);
1131 /* If 'arg' is a valid name of this metadata type, allocate and
1132 * return a 'supertype' for the particular minor version */
1133 struct supertype
* (*match_metadata_desc
)(char *arg
);
1134 /* If a device has the given size, and the data_offset has been
1135 * requested - work out how much space is available for data.
1136 * This involves adjusting for reserved space (e.g. bitmaps)
1137 * and for any rounding.
1138 * 'mdadm' only calls this for existing arrays where a possible
1139 * spare is being added. However some super-handlers call it
1140 * internally from validate_geometry when creating an array.
1142 __u64 (*avail_size
)(struct supertype
*st
, __u64 size
,
1143 unsigned long long data_offset
);
1145 * Return spare criteria for array:
1146 * - minimum disk size can be used in array;
1147 * - sector size can be used in array.
1149 mdadm_status_t (*get_spare_criteria
)(struct supertype
*st
, char *mddev_path
,
1150 struct spare_criteria
*sc
);
1151 /* Find somewhere to put a bitmap - possibly auto-size it - and
1152 * update the metadata to record this. The array may be newly
1153 * created, in which case data_size may be updated, or it might
1154 * already exist. Metadata handler can know if init_super
1155 * has been called, but not write_init_super.
1159 int (*add_internal_bitmap
)(struct supertype
*st
, int *chunkp
,
1160 int delay
, int write_behind
,
1161 unsigned long long size
, int may_change
, int major
);
1162 /* Perform additional setup required to activate a bitmap.
1164 int (*set_bitmap
)(struct supertype
*st
, struct mdinfo
*info
);
1165 /* Seek 'fd' to start of write-intent-bitmap. Must be an
1166 * md-native format bitmap
1168 int (*locate_bitmap
)(struct supertype
*st
, int fd
, int node_num
);
1169 /* if add_internal_bitmap succeeded for existing array, this
1172 int (*write_bitmap
)(struct supertype
*st
, int fd
, enum bitmap_update update
);
1173 /* Free the superblock and any other allocated data */
1174 void (*free_super
)(struct supertype
*st
);
1176 /* validate_geometry is called with an st returned by
1177 * match_metadata_desc.
1178 * It should check that the geometry described is compatible with
1179 * the metadata type. It will be called repeatedly as devices
1180 * added to validate changing size and new devices. If there are
1181 * inter-device dependencies, it should record sufficient details
1182 * so these can be validated.
1183 * Both 'size' and '*freesize' are in sectors. chunk is KiB.
1185 * 1: everything is OK
1186 * 0: not OK for some reason - if 'verbose', then error was reported.
1187 * -1: st->sb was NULL, 'subdev' is a member of a container of this
1188 * type, but array is not acceptable for some reason
1189 * message was reported even if verbose is 0.
1191 int (*validate_geometry
)(struct supertype
*st
, int level
, int layout
,
1193 int *chunk
, unsigned long long size
,
1194 unsigned long long data_offset
,
1195 char *subdev
, unsigned long long *freesize
,
1196 int consistency_policy
, int verbose
);
1199 * test_and_add_drive_policies() - test new and add custom policies from metadata handler.
1200 * @pols: list of currently recorded policies.
1201 * @disk_fd: file descriptor of the device to check.
1202 * @verbose: verbose flag.
1204 * Used by IMSM to verify all drives in container/array, against requirements not recored
1205 * in superblock, like controller type for IMSM. It should check all drives even if
1206 * they are not actually used, because mdmon or kernel are free to use any drive assigned to
1207 * container automatically.
1209 * Generating and comparison methods belong to metadata handler. It is not mandatory to be
1212 * Return: MDADM_STATUS_SUCCESS is expected on success.
1214 mdadm_status_t (*test_and_add_drive_policies
)(dev_policy_t
**pols
, int disk_fd
,
1217 /* Return a linked list of 'mdinfo' structures for all arrays
1218 * in the container. For non-containers, it is like
1219 * getinfo_super with an allocated mdinfo.*/
1220 struct mdinfo
*(*container_content
)(struct supertype
*st
, char *subarray
);
1221 /* query the supertype for default geometry */
1222 void (*default_geometry
)(struct supertype
*st
, int *level
, int *layout
, int *chunk
); /* optional */
1223 /* Permit subarray's to be deleted from inactive containers */
1224 int (*kill_subarray
)(struct supertype
*st
,
1225 char *subarray_id
); /* optional */
1227 * update_subarray() - Permit subarray to be modified.
1229 * @subarray: Subarray name.
1230 * @update: Update option.
1231 * @ident: Optional identifiers.
1233 int (*update_subarray
)(struct supertype
*st
, char *subarray
,
1234 enum update_opt update
, struct mddev_ident
*ident
);
1235 /* Check if reshape is supported for this external format.
1236 * st is obtained from super_by_fd() where st->subarray[0] is
1237 * initialized to indicate if reshape is being performed at the
1238 * container or subarray level
1241 int (*reshape_super
)(struct supertype
*st
, struct shape
*shape
, struct context
*c
);
1242 int (*manage_reshape
)( /* optional */
1243 int afd
, struct mdinfo
*sra
, struct reshape
*reshape
,
1244 struct supertype
*st
, unsigned long blocks
,
1245 int *fds
, unsigned long long *offsets
,
1246 int dests
, int *destfd
, unsigned long long *destoffsets
);
1249 int (*open_new
)(struct supertype
*c
, struct active_array
*a
,
1252 /* Tell the metadata handler the current state of the array.
1253 * This covers whether it is known to be consistent (no pending writes)
1254 * and how far along a resync is known to have progressed
1255 * (in a->resync_start).
1256 * resync status is really irrelevant if the array is not consistent,
1257 * but some metadata (DDF!) have a place to record the distinction.
1258 * If 'consistent' is '2', then the array can mark it dirty if a
1259 * resync/recovery/whatever is required, or leave it clean if not.
1260 * Return value is 0 dirty (not consistent) and 1 if clean.
1261 * it is only really important if consistent is passed in as '2'.
1263 int (*set_array_state
)(struct active_array
*a
, int consistent
);
1265 /* When the state of a device might have changed, we call set_disk to
1266 * tell the metadata what the current state is.
1267 * Typically this happens on spare->in_sync and (spare|in_sync)->faulty
1269 * set_disk might be called when the state of the particular disk has
1270 * not in fact changed.
1272 void (*set_disk
)(struct active_array
*a
, int n
, int state
);
1273 void (*sync_metadata
)(struct supertype
*st
);
1274 void (*process_update
)(struct supertype
*st
,
1275 struct metadata_update
*update
);
1276 /* Prepare updates allocates extra memory that might be
1277 * needed. If the update cannot be understood, return 0.
1279 int (*prepare_update
)(struct supertype
*st
,
1280 struct metadata_update
*update
);
1282 /* activate_spare will check if the array is degraded and, if it
1283 * is, try to find some spare space in the container.
1284 * On success, it add appropriate updates (For process_update) to
1285 * to the 'updates' list and returns a list of 'mdinfo' identifying
1286 * the device, or devices as there might be multiple missing
1287 * devices and multiple spares available.
1289 struct mdinfo
*(*activate_spare
)(struct active_array
*a
,
1290 struct metadata_update
**updates
);
1292 /* for external backup area */
1293 int (*recover_backup
)(struct supertype
*st
, struct mdinfo
*info
);
1295 /* validate container after assemble */
1296 int (*validate_container
)(struct mdinfo
*info
);
1298 /* write initial empty PPL on device */
1299 int (*write_init_ppl
)(struct supertype
*st
, struct mdinfo
*info
, int fd
);
1301 /* validate ppl before assemble */
1302 int (*validate_ppl
)(struct supertype
*st
, struct mdinfo
*info
,
1303 struct mdinfo
*disk
);
1305 /* records new bad block in metadata */
1306 int (*record_bad_block
)(struct active_array
*a
, int n
,
1307 unsigned long long sector
, int length
);
1309 /* clears bad block from metadata */
1310 int (*clear_bad_block
)(struct active_array
*a
, int n
,
1311 unsigned long long sector
, int length
);
1313 /* get list of bad blocks from metadata */
1314 struct md_bb
*(*get_bad_blocks
)(struct active_array
*a
, int n
);
1316 int swapuuid
; /* true if uuid is bigending rather than hostendian */
1318 const char *name
; /* canonical metadata name */
1321 extern struct superswitch super0
, super1
;
1322 extern struct superswitch super_imsm
, super_ddf
;
1323 extern struct superswitch mbr
, gpt
;
1325 void imsm_set_no_platform(int v
);
1327 struct metadata_update
{
1330 void *space
; /* allocated space that monitor will use */
1331 void **space_list
; /* list of allocated spaces that monitor can
1332 * use or that it returned.
1334 struct metadata_update
*next
;
1337 /* A supertype holds a particular collection of metadata.
1338 * It identifies the metadata type by the superswitch, and the particular
1339 * sub-version of that metadata type.
1340 * metadata read in or created is stored in 'sb' and 'info'.
1341 * There are also fields used by mdmon to track containers.
1343 * A supertype may refer to:
1344 * Just an array, possibly in a container
1345 * A container, not identifying any particular array
1346 * Info read from just one device, not yet fully describing the array/container.
1349 * A supertype is created by:
1355 struct superswitch
*ss
;
1358 char container_devnm
[32]; /* devnm of container */
1361 void *other
; /* Hack used to convert v0.90 to v1.0 */
1362 unsigned long long devsize
;
1363 unsigned long long data_offset
; /* used by v1.x only */
1364 int ignore_hw_compat
; /* used to inform metadata handlers that it should ignore
1365 HW/firmware related incompatability to load metadata.
1366 Used when examining metadata to display content of disk
1367 when user has no hw/firmare compatible system.
1369 struct metadata_update
*updates
;
1370 struct metadata_update
**update_tail
;
1372 /* extra stuff used by mdmon */
1373 struct active_array
*arrays
;
1374 int sock
; /* listen to external programs */
1375 char devnm
[32]; /* e.g. md0. This appears in metadata_version:
1383 struct mdinfo
*devs
;
1387 extern struct supertype
*super_by_fd(int fd
, char **subarray
);
1388 enum guess_types
{ guess_any
, guess_array
, guess_partitions
};
1389 extern struct supertype
*guess_super_type(int fd
, enum guess_types guess_type
);
1390 static inline struct supertype
*guess_super(int fd
) {
1391 return guess_super_type(fd
, guess_any
);
1393 extern struct supertype
*dup_super(struct supertype
*st
);
1394 extern int get_dev_size(int fd
, char *dname
, unsigned long long *sizep
);
1395 extern int get_dev_sector_size(int fd
, char *dname
, unsigned int *sectsizep
);
1396 extern int must_be_container(int fd
);
1397 void wait_for(char *dev
, int fd
);
1399 extern char pol_act
[], pol_domain
[], pol_metadata
[], pol_auto
[];
1401 /* iterate over the sublist starting at list, having the same
1402 * 'name' as 'list', and matching the given metadata (Where
1403 * NULL matches anything
1405 #define pol_for_each(item, list, _metadata) \
1407 item && item->name == list->name; \
1408 item = item->next) \
1409 if (!(!_metadata || !item->metadata || _metadata == item->metadata)) \
1413 * policy records read from mdadm are largely just name-value pairs.
1414 * The names are constants, not strdupped
1417 struct pol_rule
*next
;
1418 char *type
; /* rule_policy or rule_part */
1423 char *dups
; /* duplicates of 'value' with a partNN appended */
1427 extern char rule_policy
[], rule_part
[];
1428 extern char rule_path
[], rule_type
[];
1429 extern char type_part
[], type_disk
[];
1431 extern void policyline(char *line
, char *type
);
1432 extern void policy_add(char *type
, ...);
1433 extern void policy_free(void);
1435 extern struct dev_policy
*path_policy(char **paths
, char *type
);
1436 extern struct dev_policy
*disk_policy(struct mdinfo
*disk
);
1437 extern struct dev_policy
*devid_policy(int devid
);
1438 extern void dev_policy_free(struct dev_policy
*p
);
1440 extern void pol_add(struct dev_policy
**pol
, char *name
, char *val
, char *metadata
);
1441 extern struct dev_policy
*pol_find(struct dev_policy
*pol
, char *name
);
1443 extern mdadm_status_t
drive_test_and_add_policies(struct supertype
*st
, dev_policy_t
**pols
,
1444 int fd
, const int verbose
);
1445 extern mdadm_status_t
sysfs_test_and_add_drive_policies(struct supertype
*st
, dev_policy_t
**pols
,
1446 struct mdinfo
*mdi
, const int verbose
);
1447 extern mdadm_status_t
mddev_test_and_add_drive_policies(struct supertype
*st
, dev_policy_t
**pols
,
1448 int array_fd
, const int verbose
);
1450 enum policy_action
{
1454 act_spare
, /* This only applies to bare devices */
1455 act_spare_same_slot
, /* this allows non-bare devices,
1456 * but only if recent removal */
1457 act_force_spare
, /* this allow non-bare devices in any case */
1461 extern int policy_action_allows(struct dev_policy
*plist
, const char *metadata
,
1462 enum policy_action want
);
1463 extern int disk_action_allows(struct mdinfo
*disk
, const char *metadata
,
1464 enum policy_action want
);
1467 struct domainlist
*next
;
1471 extern int domain_test(struct domainlist
*dom
, struct dev_policy
*pol
,
1472 const char *metadata
);
1473 extern struct domainlist
*domain_from_array(struct mdinfo
*mdi
,
1474 const char *metadata
);
1475 extern void domainlist_add_dev(struct domainlist
**dom
, int devid
,
1476 const char *metadata
);
1477 extern void domain_free(struct domainlist
*dl
);
1478 extern void domain_merge(struct domainlist
**domp
, struct dev_policy
*pol
,
1479 const char *metadata
);
1480 void domain_add(struct domainlist
**domp
, char *domain
);
1482 extern void policy_save_path(char *id_path
, struct map_ent
*array
);
1483 extern int policy_check_path(struct mdinfo
*disk
, struct map_ent
*array
);
1485 extern void sysfs_rules_apply(char *devnm
, struct mdinfo
*dev
);
1486 extern void sysfsline(char *line
);
1492 #define HAVE_NFTW we assume
1496 # include <features.h>
1497 # ifndef __UCLIBC_HAS_LFS__
1498 # define lseek64 lseek
1500 # ifndef __UCLIBC_HAS_FTW__
1510 #if defined(__KLIBC__)
1526 extern int add_dev(const char *name
, const struct stat
*stb
, int flag
, struct FTW
*s
);
1528 extern int Manage_ro(char *devname
, int fd
, int readonly
);
1529 extern int Manage_run(char *devname
, int fd
, struct context
*c
);
1530 extern int Manage_stop(char *devname
, int fd
, int quiet
,
1532 extern int Manage_subdevs(char *devname
, int fd
,
1533 struct mddev_dev
*devlist
, int verbose
, int test
,
1534 enum update_opt update
, int force
);
1535 extern int autodetect(void);
1536 extern int Grow_Add_device(char *devname
, int fd
, char *newdev
);
1537 extern int Grow_addbitmap(char *devname
, int fd
,
1538 struct context
*c
, struct shape
*s
);
1539 extern int Grow_reshape(char *devname
, int fd
,
1540 struct mddev_dev
*devlist
,
1541 struct context
*c
, struct shape
*s
);
1542 extern int Grow_restart(struct supertype
*st
, struct mdinfo
*info
,
1543 int *fdlist
, int cnt
, char *backup_file
, int verbose
);
1544 extern int Grow_continue(int mdfd
, struct supertype
*st
,
1545 struct mdinfo
*info
, int forked
, struct context
*c
);
1546 extern int Grow_consistency_policy(char *devname
, int fd
,
1547 struct context
*c
, struct shape
*s
);
1549 extern int restore_backup(struct supertype
*st
,
1550 struct mdinfo
*content
,
1553 char **backup_filep
,
1555 extern int Grow_continue_command(char *devname
, int fd
, struct context
*c
);
1557 extern int Assemble(struct supertype
*st
, char *mddev
,
1558 struct mddev_ident
*ident
,
1559 struct mddev_dev
*devlist
,
1562 extern int Build(struct mddev_ident
*ident
, struct mddev_dev
*devlist
, struct shape
*s
,
1565 extern int Create(struct supertype
*st
, struct mddev_ident
*ident
, int subdevs
,
1566 struct mddev_dev
*devlist
, struct shape
*s
, struct context
*c
);
1568 extern int Detail(char *dev
, struct context
*c
);
1569 extern int Detail_Platform(struct superswitch
*ss
, int scan
, int verbose
, int export
, char *controller_path
);
1570 extern int Query(char *dev
);
1571 extern int ExamineBadblocks(char *devname
, int brief
, struct supertype
*forcest
);
1572 extern int Examine(struct mddev_dev
*devlist
, struct context
*c
,
1573 struct supertype
*forcest
);
1574 extern int Monitor(struct mddev_dev
*devlist
,
1575 char *mailaddr
, char *alert_cmd
,
1577 int daemonise
, int oneshot
,
1578 int dosyslog
, char *pidfile
, int increments
,
1581 extern int Kill(char *dev
, struct supertype
*st
, int force
, int verbose
, int noexcl
);
1582 extern int Kill_subarray(char *dev
, char *subarray
, int verbose
);
1583 extern int Update_subarray(char *dev
, char *subarray
, enum update_opt update
, struct mddev_ident
*ident
, int quiet
);
1584 extern int Wait(char *dev
);
1585 extern int WaitClean(char *dev
, int verbose
);
1586 extern int SetAction(char *dev
, char *action
);
1588 extern int Incremental(struct mddev_dev
*devlist
, struct context
*c
,
1589 struct supertype
*st
);
1590 extern void RebuildMap(void);
1591 extern int IncrementalScan(struct context
*c
, char *devnm
);
1592 extern int IncrementalRemove(char *devname
, char *path
, int verbose
);
1593 extern int CreateBitmap(char *filename
, int force
, char uuid
[16],
1594 unsigned long chunksize
, unsigned long daemon_sleep
,
1595 unsigned long write_behind
,
1596 unsigned long long array_size
,
1598 extern int ExamineBitmap(char *filename
, int brief
, struct supertype
*st
);
1599 extern int IsBitmapDirty(char *filename
);
1600 extern int Write_rules(char *rule_name
);
1601 extern int bitmap_update_uuid(int fd
, int *uuid
, int swap
);
1603 /* calculate the size of the bitmap given the array size and bitmap chunksize */
1604 static inline unsigned long long
1605 bitmap_bits(unsigned long long array_size
, unsigned long chunksize
)
1607 return (array_size
* 512 + chunksize
- 1) / chunksize
;
1610 extern int Dump_metadata(char *dev
, char *dir
, struct context
*c
,
1611 struct supertype
*st
);
1612 extern int Restore_metadata(char *dev
, char *dir
, struct context
*c
,
1613 struct supertype
*st
, int only
);
1615 int md_array_valid(int fd
);
1616 int md_array_active(int fd
);
1617 int md_array_is_active(struct mdinfo
*info
);
1618 int md_get_array_info(int fd
, struct mdu_array_info_s
*array
);
1619 int md_set_array_info(int fd
, struct mdu_array_info_s
*array
);
1620 int md_get_disk_info(int fd
, struct mdu_disk_info_s
*disk
);
1621 extern int get_linux_version(void);
1622 extern int mdadm_version(char *version
);
1623 extern unsigned long long parse_size(char *size
);
1624 extern int parse_uuid(char *str
, int uuid
[4]);
1625 int default_layout(struct supertype
*st
, int level
, int verbose
);
1626 extern int is_near_layout_10(int layout
);
1627 extern int parse_layout_10(char *layout
);
1628 extern int parse_layout_faulty(char *layout
);
1629 extern int parse_num(int *dest
, const char *num
);
1630 extern int parse_cluster_confirm_arg(char *inp
, char **devname
, int *slot
);
1631 extern int check_ext2(int fd
, char *name
);
1632 extern int check_reiser(int fd
, char *name
);
1633 extern int check_raid(int fd
, char *name
);
1634 extern int check_partitions(int fd
, char *dname
,
1635 unsigned long long freesize
,
1636 unsigned long long size
);
1637 extern bool is_name_posix_compatible(const char *path
);
1638 extern int fstat_is_blkdev(int fd
, char *devname
, dev_t
*rdev
);
1639 extern int stat_is_blkdev(char *devname
, dev_t
*rdev
);
1641 extern bool is_string_lq(const char * const str
, size_t max_len
);
1642 extern bool is_dev_alive(char *path
);
1643 extern int get_mdp_major(void);
1644 extern int get_maj_min(char *dev
, int *major
, int *minor
);
1645 extern bool is_bit_set(int *val
, unsigned char index
);
1646 extern int dev_open(char *dev
, int flags
);
1647 extern int open_dev(char *devnm
);
1648 extern void reopen_mddev(int mdfd
);
1649 extern int open_dev_flags(char *devnm
, int flags
);
1650 extern int open_dev_excl(char *devnm
);
1651 extern int is_standard(char *dev
, int *nump
);
1652 extern int same_dev(char *one
, char *two
);
1653 extern int compare_paths (char* path1
,char* path2
);
1654 extern void enable_fds(int devices
);
1655 extern void manage_fork_fds(int close_all
);
1656 extern int continue_via_systemd(char *devnm
, char *service_name
, char *prefix
);
1658 extern void ident_init(struct mddev_ident
*ident
);
1659 extern mdadm_status_t
ident_set_devname(struct mddev_ident
*ident
, const char *devname
);
1660 extern mdadm_status_t
ident_set_name(struct mddev_ident
*ident
, const char *name
);
1662 extern int parse_auto(char *str
, char *msg
, int config
);
1663 extern struct mddev_ident
*conf_get_ident(char *dev
);
1664 extern struct mddev_dev
*conf_get_devs(void);
1665 extern int conf_test_dev(char *devname
);
1666 extern int conf_test_metadata(const char *version
, struct dev_policy
*pol
, int is_homehost
);
1667 extern struct createinfo
*conf_get_create_info(void);
1668 extern void set_conffile(char *file
);
1669 extern char *conf_get_mailaddr(void);
1670 extern char *conf_get_mailfrom(void);
1671 extern char *conf_get_program(void);
1672 extern char *conf_get_homehost(int *require_homehostp
);
1673 extern char *conf_get_homecluster(void);
1674 extern int conf_get_monitor_delay(void);
1675 extern bool conf_get_sata_opal_encryption_no_verify(void);
1676 extern char *conf_line(FILE *file
);
1677 extern char *conf_word(FILE *file
, int allow_key
);
1678 extern void print_quoted(char *str
);
1679 extern int use_udev(void);
1680 extern void print_escape(char *str
);
1681 extern unsigned long GCD(unsigned long a
, unsigned long b
);
1682 extern int conf_name_is_free(char *name
);
1683 extern bool is_devname_ignore(const char *devname
);
1684 extern bool is_devname_md_numbered(const char *devname
);
1685 extern bool is_devname_md_d_numbered(const char *devname
);
1686 extern int conf_verify_devnames(struct mddev_ident
*array_list
);
1687 extern int devname_matches(char *name
, char *match
);
1688 extern struct mddev_ident
*conf_match(struct supertype
*st
,
1689 struct mdinfo
*info
,
1691 int verbose
, int *rvp
);
1693 extern void free_line(char *line
);
1694 extern int match_oneof(char *devices
, char *devname
);
1695 extern void uuid_from_super(int uuid
[4], mdp_super_t
*super
);
1696 extern const int uuid_zero
[4];
1697 extern int same_uuid(int a
[4], int b
[4], int swapuuid
);
1698 extern void copy_uuid(void *a
, int b
[4], int swapuuid
);
1699 extern char *__fname_from_uuid(int id
[4], int swap
, char *buf
, char sep
);
1700 extern char *fname_from_uuid(struct mdinfo
*info
, char *buf
);
1701 extern unsigned long calc_csum(void *super
, int bytes
);
1702 extern int enough(int level
, int raid_disks
, int layout
, int clean
,
1704 extern int ask(char *mesg
);
1705 extern unsigned long long get_component_size(int fd
);
1706 extern void remove_partitions(int fd
);
1707 extern int test_partition(int fd
);
1708 extern int test_partition_from_id(dev_t id
);
1709 extern int get_data_disks(int level
, int layout
, int raid_disks
);
1710 extern unsigned long long calc_array_size(int level
, int raid_disks
, int layout
,
1711 int chunksize
, unsigned long long devsize
);
1712 extern int flush_metadata_updates(struct supertype
*st
);
1713 extern void append_metadata_update(struct supertype
*st
, void *buf
, int len
);
1714 extern int assemble_container_content(struct supertype
*st
, int mdfd
,
1715 struct mdinfo
*content
,
1717 char *chosen_name
, int *result
);
1719 #define INCR_UNSAFE 2
1720 #define INCR_ALREADY 4
1723 extern bool devid_matches_criteria(struct supertype
*st
, dev_t devid
, struct spare_criteria
*sc
);
1724 extern bool disk_fd_matches_criteria(struct supertype
*st
, int disk_fd
, struct spare_criteria
*sc
);
1725 extern struct mdinfo
*container_choose_spares(struct supertype
*st
,
1726 struct spare_criteria
*criteria
,
1727 struct domainlist
*domlist
,
1729 const char *metadata
, int get_one
);
1730 extern int move_spare(char *from_devname
, char *to_devname
, dev_t devid
);
1731 extern int add_disk(int mdfd
, struct supertype
*st
,
1732 struct mdinfo
*sra
, struct mdinfo
*info
);
1733 extern int remove_disk(int mdfd
, struct supertype
*st
,
1734 struct mdinfo
*sra
, struct mdinfo
*info
);
1735 extern int hot_remove_disk(int mdfd
, unsigned long dev
, int force
);
1736 extern int sys_hot_remove_disk(int statefd
, int force
);
1737 extern int set_array_info(int mdfd
, struct supertype
*st
, struct mdinfo
*info
);
1738 unsigned long long min_recovery_start(struct mdinfo
*array
);
1740 extern char *human_size(long long bytes
);
1741 extern char *human_size_brief(long long bytes
, int prefix
);
1742 extern void print_r10_layout(int layout
);
1744 extern char *find_free_devnm(int use_partitions
);
1746 extern void put_md_name(char *name
);
1747 extern char *devid2kname(dev_t devid
);
1748 extern char *devid2devnm(dev_t devid
);
1749 extern dev_t
devnm2devid(char *devnm
);
1750 extern char *get_md_name(char *devnm
);
1752 extern char DefaultConfFile
[];
1754 extern int create_mddev(char *dev
, char *name
, int autof
, int trustworthy
,
1755 char *chosen
, int block_udev
);
1756 /* values for 'trustworthy' */
1758 #define LOCAL_ANY 10
1761 extern int open_mddev(char *dev
, int report_errors
);
1762 extern int is_mddev(char *dev
);
1763 extern int open_container(int fd
);
1764 extern int metadata_container_matches(char *metadata
, char *devnm
);
1765 extern int metadata_subdev_matches(char *metadata
, char *devnm
);
1766 extern int is_container_member(struct mdstat_ent
*ent
, char *devname
);
1767 extern int is_subarray_active(char *subarray
, char *devname
);
1768 extern int open_subarray(char *dev
, char *subarray
, struct supertype
*st
, int quiet
);
1769 extern struct superswitch
*version_to_superswitch(char *vers
);
1771 extern int mdmon_running(char *devnm
);
1772 extern int mdmon_pid(char *devnm
);
1773 extern int check_env(char *name
);
1774 extern __u32
random32(void);
1775 extern void random_uuid(__u8
*buf
);
1776 extern int start_mdmon(char *devnm
);
1778 extern int child_monitor(int afd
, struct mdinfo
*sra
, struct reshape
*reshape
,
1779 struct supertype
*st
, unsigned long stripes
,
1780 int *fds
, unsigned long long *offsets
,
1781 int dests
, int *destfd
, unsigned long long *destoffsets
);
1782 void abort_reshape(struct mdinfo
*sra
);
1784 void *super1_make_v0(struct supertype
*st
, struct mdinfo
*info
, mdp_super_t
*sb0
);
1786 extern char *stat2kname(struct stat
*st
);
1787 extern char *fd2kname(int fd
);
1788 extern char *stat2devnm(struct stat
*st
);
1789 bool stat_is_md_dev(struct stat
*st
);
1790 extern char *fd2devnm(int fd
);
1792 extern int in_initrd(void);
1795 void *cmap_handle
; /* corosync lib related */
1797 int (*initialize
)(cmap_handle_t
*handle
);
1798 int (*get_string
)(cmap_handle_t handle
,
1801 int (*finalize
)(cmap_handle_t handle
);
1804 extern void set_cmap_hooks(void);
1805 extern void set_hooks(void);
1808 void *dlm_handle
; /* dlm lib related */
1810 dlm_lshandle_t (*create_lockspace
)(const char *name
,
1812 dlm_lshandle_t (*open_lockspace
)(const char *name
);
1813 int (*release_lockspace
)(const char *name
, dlm_lshandle_t ls
,
1815 int (*ls_lock
)(dlm_lshandle_t lockspace
, uint32_t mode
,
1816 struct dlm_lksb
*lksb
, uint32_t flags
,
1817 const void *name
, unsigned int namelen
,
1818 uint32_t parent
, void (*astaddr
) (void *astarg
),
1819 void *astarg
, void (*bastaddr
) (void *astarg
),
1821 int (*ls_unlock_wait
)(dlm_lshandle_t lockspace
, uint32_t lkid
,
1822 uint32_t flags
, struct dlm_lksb
*lksb
);
1823 int (*ls_get_fd
)(dlm_lshandle_t ls
);
1824 int (*dispatch
)(int fd
);
1827 extern int get_cluster_name(char **name
);
1828 extern int dlm_funs_ready(void);
1829 extern int cluster_get_dlmlock(void);
1830 extern int cluster_release_dlmlock(void);
1831 extern void set_dlm_hooks(void);
1833 #define MSEC_TO_NSEC(msec) ((msec) * 1000000)
1834 #define USEC_TO_NSEC(usec) ((usec) * 1000)
1835 extern void sleep_for(unsigned int sec
, long nsec
, bool wake_after_interrupt
);
1836 extern bool is_directory(const char *path
);
1837 extern bool is_file(const char *path
);
1838 extern int s_gethostname(char *buf
, int buf_len
);
1840 #define _ROUND_UP(val, base) (((val) + (base) - 1) & ~(base - 1))
1841 #define ROUND_UP(val, base) _ROUND_UP(val, (typeof(val))(base))
1842 #define ROUND_UP_PTR(ptr, base) ((typeof(ptr)) \
1843 (ROUND_UP((unsigned long)(ptr), base)))
1845 static inline int is_subarray(char *vers
)
1847 /* The version string for a 'subarray' (an array in a container)
1849 * /containername/componentname for normal read-write arrays
1850 * -containername/componentname for arrays which mdmon must not
1851 * reconfigure. They might be read-only
1852 * or might be undergoing reshape etc.
1853 * containername is e.g. md0, md_d1
1854 * componentname is dependant on the metadata. e.g. '1' 'S1' ...
1856 return (*vers
== '/' || *vers
== '-');
1859 static inline char *to_subarray(struct mdstat_ent
*ent
, char *container
)
1861 return &ent
->metadata_version
[10+strlen(container
)+1];
1865 * signal_s() - Wrapper for sigaction() with signal()-like interface.
1866 * @sig: The signal to set the signal handler to.
1867 * @handler: The signal handler.
1869 * Return: previous handler or SIG_ERR on failure.
1871 static inline sighandler_t
signal_s(int sig
, sighandler_t handler
)
1873 struct sigaction new_act
= {0};
1874 struct sigaction old_act
= {0};
1876 new_act
.sa_handler
= handler
;
1878 if (sigaction(sig
, &new_act
, &old_act
) == 0)
1879 return old_act
.sa_handler
;
1885 #define dprintf(fmt, arg...) \
1886 fprintf(stderr, "%s: %s: "fmt, Name, __func__, ##arg)
1887 #define dprintf_cont(fmt, arg...) \
1888 fprintf(stderr, fmt, ##arg)
1890 #define dprintf(fmt, arg...) \
1891 ({ if (0) fprintf(stderr, "%s: %s: " fmt, Name, __func__, ##arg); 0; })
1892 #define dprintf_cont(fmt, arg...) \
1893 ({ if (0) fprintf(stderr, fmt, ##arg); 0; })
1896 static inline int xasprintf(char **strp
, const char *fmt
, ...) {
1900 ret
= vasprintf(strp
, fmt
, ap
);
1907 #define pr_err(fmt, args...) fprintf(stderr, "%s: %s: "fmt, Name, __func__, ##args)
1909 #define pr_err(fmt, args...) fprintf(stderr, "%s: "fmt, Name, ##args)
1911 #define cont_err(fmt ...) fprintf(stderr, " " fmt)
1913 #define pr_info(fmt, args...) printf("%s: "fmt, Name, ##args)
1915 #define pr_vrb(fmt, arg...) ((void)(verbose && pr_err(fmt, ##arg)))
1917 void *xmalloc(size_t len
);
1918 void *xrealloc(void *ptr
, size_t len
);
1919 void *xcalloc(size_t num
, size_t size
);
1920 char *xstrdup(const char *str
);
1922 #define LEVEL_MULTIPATH (-4)
1923 #define LEVEL_LINEAR (-1)
1924 #define LEVEL_FAULTY (-5)
1926 /* kernel module doesn't know about these */
1927 #define LEVEL_CONTAINER (-100)
1928 #define LEVEL_UNSUPPORTED (-200)
1930 /* the kernel does know about this one ... */
1931 #define LEVEL_NONE (-1000000)
1935 #define WriteTransient 0
1936 #define ReadTransient 1
1937 #define WritePersistent 2
1938 #define ReadPersistent 3
1939 #define WriteAll 4 /* doesn't go to device */
1940 #define ReadFixable 5
1943 #define ClearErrors 31
1944 #define ClearFaults 30
1946 #define AllPersist 100 /* internal use only */
1947 #define NoPersist 101
1949 #define ModeMask 0x1f
1956 #define minor(x) ((x)&0xff)
1957 #define major(x) (((x)>>8)&0xff)
1958 #define makedev(M,m) (((M)<<8) | (m))
1962 RAID0_ORIG_LAYOUT
= 1,
1963 RAID0_ALT_MULTIZONE_LAYOUT
= 2,
1967 #define ALGORITHM_LEFT_ASYMMETRIC 0
1968 #define ALGORITHM_RIGHT_ASYMMETRIC 1
1969 #define ALGORITHM_LEFT_SYMMETRIC 2
1970 #define ALGORITHM_RIGHT_SYMMETRIC 3
1972 /* Define non-rotating (raid4) algorithms. These allow
1973 * conversion of raid4 to raid5.
1975 #define ALGORITHM_PARITY_0 4 /* P or P,Q are initial devices */
1976 #define ALGORITHM_PARITY_N 5 /* P or P,Q are final devices. */
1978 /* DDF RAID6 layouts differ from md/raid6 layouts in two ways.
1979 * Firstly, the exact positioning of the parity block is slightly
1980 * different between the 'LEFT_*' modes of md and the "_N_*" modes
1982 * Secondly, or order of datablocks over which the Q syndrome is computed
1984 * Consequently we have different layouts for DDF/raid6 than md/raid6.
1985 * These layouts are from the DDFv1.2 spec.
1986 * Interestingly DDFv1.2-Errata-A does not specify N_CONTINUE but
1987 * leaves RLQ=3 as 'Vendor Specific'
1990 #define ALGORITHM_ROTATING_ZERO_RESTART 8 /* DDF PRL=6 RLQ=1 */
1991 #define ALGORITHM_ROTATING_N_RESTART 9 /* DDF PRL=6 RLQ=2 */
1992 #define ALGORITHM_ROTATING_N_CONTINUE 10 /*DDF PRL=6 RLQ=3 */
1994 /* For every RAID5 algorithm we define a RAID6 algorithm
1995 * with exactly the same layout for data and parity, and
1996 * with the Q block always on the last device (N-1).
1997 * This allows trivial conversion from RAID5 to RAID6
1999 #define ALGORITHM_LEFT_ASYMMETRIC_6 16
2000 #define ALGORITHM_RIGHT_ASYMMETRIC_6 17
2001 #define ALGORITHM_LEFT_SYMMETRIC_6 18
2002 #define ALGORITHM_RIGHT_SYMMETRIC_6 19
2003 #define ALGORITHM_PARITY_0_6 20
2004 #define ALGORITHM_PARITY_N_6 ALGORITHM_PARITY_N
2006 /* Define PATH_MAX in case we don't use glibc or standard library does
2007 * not have PATH_MAX defined. Assume max path length is 4K characters.
2010 #define PATH_MAX 4096
2013 #define RESYNC_NONE -1
2014 #define RESYNC_DELAYED -2
2015 #define RESYNC_PENDING -3
2016 #define RESYNC_REMOTE -4
2017 #define RESYNC_UNKNOWN -5
2019 /* When using "GET_DISK_INFO" it isn't certain how high
2020 * we need to check. So we impose an absolute limit of
2021 * MAX_DISKS. This needs to be much more than the largest
2022 * number of devices any metadata can support. Currently
2023 * v1.x can support 1920
2025 #define MAX_DISKS 4096
2027 /* Sometimes the 'size' value passed needs to mean "Maximum".
2028 * In those cases with use MAX_SIZE
2032 /* We want to use unsigned numbers for sector counts, but need
2033 * a value for 'invalid'. Use '1'.
2035 #define INVALID_SECTORS 1
2036 /* And another special number needed for --data_offset=variable */
2037 #define VARIABLE_OFFSET 3
2040 * is_container() - check if @level is &LEVEL_CONTAINER
2041 * @level: level value
2044 * 1 if level is equal to &LEVEL_CONTAINER, 0 otherwise.
2046 static inline int is_container(const int level
)
2048 if (level
== LEVEL_CONTAINER
)
2053 #define STR_COMMON_NONE "none"
2056 * str_is_none() - check if @str starts with "none".
2060 * true if string starts with "none", false otherwise.
2062 static inline bool str_is_none(char *str
)
2064 if (strncmp(str
, STR_COMMON_NONE
, sizeof(STR_COMMON_NONE
) - 1) == 0)