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