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