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