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