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