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