]> git.ipfire.org Git - thirdparty/mdadm.git/blob - mdadm.h
64f41fd0285e62c2c9b283b6b69f9df54323b3d5
[thirdparty/mdadm.git] / mdadm.h
1 /*
2 * mdadm - manage Linux "md" devices aka RAID arrays.
3 *
4 * Copyright (C) 2001-2006 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@cse.unsw.edu.au>
23 * Paper: Neil Brown
24 * School of Computer Science and Engineering
25 * The University of New South Wales
26 * Sydney, 2052
27 * Australia
28 */
29
30 #define _GNU_SOURCE
31 #define _FILE_OFFSET_BITS 64
32 #include <unistd.h>
33 #if !defined(__dietlibc__) && !defined(__KLIBC__)
34 extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
35 #else
36 # if defined(__NO_STAT64) || __WORDSIZE != 32
37 # define lseek64 lseek
38 # endif
39 #endif
40
41 #include <sys/types.h>
42 #include <sys/stat.h>
43 #include <stdlib.h>
44 #include <time.h>
45 #include <sys/time.h>
46 #include <getopt.h>
47 #include <fcntl.h>
48 #include <stdio.h>
49 #include <errno.h>
50 #include <string.h>
51 #include <syslog.h>
52 #ifdef __dietlibc__
53 #include <strings.h>
54 /* dietlibc has deprecated random and srandom!! */
55 #define random rand
56 #define srandom srand
57 #endif
58
59
60 #include <linux/kdev_t.h>
61 /*#include <linux/fs.h> */
62 #include <sys/mount.h>
63 #include <asm/types.h>
64 #include <sys/ioctl.h>
65 #define MD_MAJOR 9
66 #define MdpMinorShift 6
67
68 #ifndef BLKGETSIZE64
69 #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
70 #endif
71
72 #define DEFAULT_BITMAP_CHUNK 4096
73 #define DEFAULT_BITMAP_DELAY 5
74 #define DEFAULT_MAX_WRITE_BEHIND 256
75
76 #include "md_u.h"
77 #include "md_p.h"
78 #include "bitmap.h"
79 #include "msg.h"
80
81 #include <endian.h>
82 /* Redhat don't like to #include <asm/byteorder.h>, and
83 * some time include <linux/byteorder/xxx_endian.h> isn't enough,
84 * and there is no standard conversion function so... */
85 /* And dietlibc doesn't think byteswap is ok, so.. */
86 /* #include <byteswap.h> */
87 #define bswap_16(x) (((x) & 0x00ffU) << 8 | \
88 ((x) & 0xff00U) >> 8)
89 #define bswap_32(x) (((x) & 0x000000ffU) << 24 | \
90 ((x) & 0xff000000U) >> 24 | \
91 ((x) & 0x0000ff00U) << 8 | \
92 ((x) & 0x00ff0000U) >> 8)
93 #define bswap_64(x) (((x) & 0x00000000000000ffULL) << 56 | \
94 ((x) & 0xff00000000000000ULL) >> 56 | \
95 ((x) & 0x000000000000ff00ULL) << 40 | \
96 ((x) & 0x00ff000000000000ULL) >> 40 | \
97 ((x) & 0x0000000000ff0000ULL) << 24 | \
98 ((x) & 0x0000ff0000000000ULL) >> 24 | \
99 ((x) & 0x00000000ff000000ULL) << 8 | \
100 ((x) & 0x000000ff00000000ULL) >> 8)
101
102 #if !defined(__KLIBC__)
103 #if BYTE_ORDER == LITTLE_ENDIAN
104 #define __cpu_to_le16(_x) (_x)
105 #define __cpu_to_le32(_x) (_x)
106 #define __cpu_to_le64(_x) (_x)
107 #define __le16_to_cpu(_x) (_x)
108 #define __le32_to_cpu(_x) (_x)
109 #define __le64_to_cpu(_x) (_x)
110
111 #define __cpu_to_be16(_x) bswap_16(_x)
112 #define __cpu_to_be32(_x) bswap_32(_x)
113 #define __cpu_to_be64(_x) bswap_64(_x)
114 #define __be16_to_cpu(_x) bswap_16(_x)
115 #define __be32_to_cpu(_x) bswap_32(_x)
116 #define __be64_to_cpu(_x) bswap_64(_x)
117 #elif BYTE_ORDER == BIG_ENDIAN
118 #define __cpu_to_le16(_x) bswap_16(_x)
119 #define __cpu_to_le32(_x) bswap_32(_x)
120 #define __cpu_to_le64(_x) bswap_64(_x)
121 #define __le16_to_cpu(_x) bswap_16(_x)
122 #define __le32_to_cpu(_x) bswap_32(_x)
123 #define __le64_to_cpu(_x) bswap_64(_x)
124
125 #define __cpu_to_be16(_x) (_x)
126 #define __cpu_to_be32(_x) (_x)
127 #define __cpu_to_be64(_x) (_x)
128 #define __be16_to_cpu(_x) (_x)
129 #define __be32_to_cpu(_x) (_x)
130 #define __be64_to_cpu(_x) (_x)
131 #else
132 # error "unknown endianness."
133 #endif
134 #endif /* __KLIBC__ */
135
136
137
138 /* general information that might be extracted from a superblock */
139 struct mdinfo {
140 mdu_array_info_t array;
141 mdu_disk_info_t disk;
142 __u64 events;
143 int uuid[4];
144 char name[33];
145 unsigned long long data_offset;
146 unsigned long long component_size; /* same as array.size, except in
147 * sectors and up to 64bits.
148 */
149 int reshape_active;
150 unsigned long long reshape_progress;
151 unsigned long long resync_start;
152 int new_level, delta_disks, new_layout, new_chunk;
153 int errors;
154 int cache_size; /* size of raid456 stripe cache*/
155 int mismatch_cnt;
156 char text_version[50];
157 int container_member; /* for assembling external-metatdata arrays */
158
159 char sys_name[20];
160 struct mdinfo *devs;
161 struct mdinfo *next;
162 };
163
164 struct createinfo {
165 int uid;
166 int gid;
167 int autof;
168 int mode;
169 int symlinks;
170 struct supertype *supertype;
171 };
172
173 #define Name "mdadm"
174
175 enum mode {
176 ASSEMBLE=1,
177 BUILD,
178 CREATE,
179 MANAGE,
180 MISC,
181 MONITOR,
182 GROW,
183 INCREMENTAL,
184 AUTODETECT,
185 };
186
187 extern char short_options[];
188 extern char short_bitmap_options[];
189 extern char short_bitmap_auto_options[];
190 extern struct option long_options[];
191 extern char Version[], Usage[], Help[], OptionHelp[],
192 Help_create[], Help_build[], Help_assemble[], Help_grow[],
193 Help_incr[],
194 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
195
196 /* for option that don't have short equivilents, we assign arbitrary
197 * small numbers. '1' means an undecorated option, so we start at '2'.
198 */
199 enum special_options {
200 AssumeClean = 2,
201 BitmapChunk,
202 WriteBehind,
203 ReAdd,
204 NoDegraded,
205 Sparc22,
206 BackupFile,
207 HomeHost,
208 AutoHomeHost,
209 Symlinks,
210 AutoDetect,
211 };
212
213 /* structures read from config file */
214 /* List of mddevice names and identifiers
215 * Identifiers can be:
216 * uuid=128-hex-uuid
217 * super-minor=decimal-minor-number-from-superblock
218 * devices=comma,separated,list,of,device,names,with,wildcards
219 *
220 * If multiple fields are present, the intersection of all matching
221 * devices is considered
222 */
223 #define UnSet (0xfffe)
224 typedef struct mddev_ident_s {
225 char *devname;
226
227 int uuid_set;
228 int uuid[4];
229 char name[33];
230
231 unsigned int super_minor;
232
233 char *devices; /* comma separated list of device
234 * names with wild cards
235 */
236 int level;
237 unsigned int raid_disks;
238 unsigned int spare_disks;
239 struct supertype *st;
240 int autof; /* 1 for normal, 2 for partitioned */
241 char *spare_group;
242 char *bitmap_file;
243 int bitmap_fd;
244
245 struct mddev_ident_s *next;
246 } *mddev_ident_t;
247
248 /* List of device names - wildcards expanded */
249 typedef struct mddev_dev_s {
250 char *devname;
251 char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
252 * Not set for names read from .config
253 */
254 char writemostly;
255 char re_add;
256 char used; /* set when used */
257 struct mddev_dev_s *next;
258 } *mddev_dev_t;
259
260 typedef struct mapping {
261 char *name;
262 int num;
263 } mapping_t;
264
265
266 struct mdstat_ent {
267 char *dev;
268 int devnum;
269 int active;
270 char *level;
271 char *pattern; /* U or up, _ for down */
272 int percent; /* -1 if no resync */
273 int resync; /* 1 if resync, 0 if recovery */
274 struct mdstat_ent *next;
275 };
276
277 extern struct mdstat_ent *mdstat_read(int hold, int start);
278 extern void free_mdstat(struct mdstat_ent *ms);
279 extern void mdstat_wait(int seconds);
280 extern int mddev_busy(int devnum);
281
282 struct map_ent {
283 struct map_ent *next;
284 int devnum;
285 int major,minor;
286 int uuid[4];
287 char *path;
288 };
289 extern int map_update(struct map_ent **mpp, int devnum, int major, int minor,
290 int uuid[4], char *path);
291 extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
292 extern void map_read(struct map_ent **melp);
293 extern int map_write(struct map_ent *mel);
294 extern void map_delete(struct map_ent **mapp, int devnum);
295 extern void map_free(struct map_ent *map);
296 extern void map_add(struct map_ent **melp,
297 int devnum, int major, int minor, int uuid[4], char *path);
298
299 /* various details can be requested */
300 #define GET_LEVEL 1
301 #define GET_LAYOUT 2
302 #define GET_COMPONENT 4
303 #define GET_CHUNK 8
304 #define GET_CACHE 16
305 #define GET_MISMATCH 32
306 #define GET_VERSION 64
307
308 #define GET_DEVS 1024 /* gets role, major, minor */
309 #define GET_OFFSET 2048
310 #define GET_SIZE 4096
311 #define GET_STATE 8192
312 #define GET_ERROR 16384
313
314 /* If fd >= 0, get the array it is open on,
315 * else use devnum. >=0 -> major9. <0.....
316 */
317 extern void sysfs_free(struct mdinfo *sra);
318 extern struct mdinfo *sysfs_read(int fd, int devnum, unsigned long options);
319 extern int sysfs_set_str(struct mdinfo *sra, struct mdinfo *dev,
320 char *name, char *val);
321 extern int sysfs_set_num(struct mdinfo *sra, struct mdinfo *dev,
322 char *name, unsigned long long val);
323 extern int sysfs_get_ll(struct mdinfo *sra, struct mdinfo *dev,
324 char *name, unsigned long long *val);
325 extern int sysfs_set_array(struct mdinfo *sra,
326 struct mdinfo *info);
327 extern int sysfs_add_disk(struct mdinfo *sra, int fd, struct mdinfo *sd);
328
329
330
331
332 extern int save_stripes(int *source, unsigned long long *offsets,
333 int raid_disks, int chunk_size, int level, int layout,
334 int nwrites, int *dest,
335 unsigned long long start, unsigned long long length);
336 extern int restore_stripes(int *dest, unsigned long long *offsets,
337 int raid_disks, int chunk_size, int level, int layout,
338 int source, unsigned long long read_offset,
339 unsigned long long start, unsigned long long length);
340
341 #ifndef Sendmail
342 #define Sendmail "/usr/lib/sendmail -t"
343 #endif
344
345 #define SYSLOG_FACILITY LOG_DAEMON
346
347 extern char *map_num(mapping_t *map, int num);
348 extern int map_name(mapping_t *map, char *name);
349 extern mapping_t r5layout[], pers[], modes[], faultylayout[];
350
351 extern char *map_dev(int major, int minor, int create);
352
353
354 extern struct superswitch {
355 void (*examine_super)(struct supertype *st, char *homehost);
356 void (*brief_examine_super)(struct supertype *st);
357 void (*export_examine_super)(struct supertype *st);
358 void (*detail_super)(struct supertype *st, char *homehost);
359 void (*brief_detail_super)(struct supertype *st);
360 void (*export_detail_super)(struct supertype *st);
361 void (*uuid_from_super)(struct supertype *st, int uuid[4]);
362 void (*getinfo_super)(struct supertype *st, struct mdinfo *info);
363 void (*getinfo_super_n)(struct supertype *st, struct mdinfo *info);
364 int (*match_home)(struct supertype *st, char *homehost);
365 int (*update_super)(struct supertype *st, struct mdinfo *info,
366 char *update,
367 char *devname, int verbose,
368 int uuid_set, char *homehost);
369 int (*init_super)(struct supertype *st, mdu_array_info_t *info,
370 unsigned long long size, char *name,
371 char *homehost, int *uuid);
372 void (*add_to_super)(struct supertype *st, mdu_disk_info_t *dinfo,
373 int fd, char *devname);
374 int (*store_super)(struct supertype *st, int fd);
375 int (*write_init_super)(struct supertype *st);
376 int (*compare_super)(struct supertype *st, struct supertype *tst);
377 int (*load_super)(struct supertype *st, int fd, char *devname);
378 struct supertype * (*match_metadata_desc)(char *arg);
379 __u64 (*avail_size)(struct supertype *st, __u64 size);
380 int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
381 int delay, int write_behind,
382 unsigned long long size, int may_change, int major);
383 void (*locate_bitmap)(struct supertype *st, int fd);
384 int (*write_bitmap)(struct supertype *st, int fd);
385 void (*free_super)(struct supertype *st);
386 int (*validate_geometry)(struct supertype *st, int level, int layout,
387 int raiddisks,
388 int chunk, unsigned long long size,
389 char *subdev, unsigned long long *freesize);
390
391 struct mdinfo *(*container_content)(struct supertype *st);
392
393 int major;
394 char *text_version;
395 int swapuuid; /* true if uuid is bigending rather than hostendian */
396 int external;
397 } super0, super1, super_ddf, super_ddf_bvd, super_ddf_svd, *superlist[];
398
399 extern struct superswitch super_imsm, super_imsm_raid;
400
401 struct supertype {
402 struct superswitch *ss;
403 int minor_version;
404 int max_devs;
405 int container_dev; /* devnum of container */
406 int container_member; /* numerical position in container */
407 void *sb;
408 void *info;
409 };
410
411 extern struct supertype supertype_container_member;
412 extern struct supertype *super_by_fd(int fd);
413 extern struct supertype *guess_super(int fd);
414 extern struct supertype *dup_super(struct supertype *st);
415 extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
416 extern void get_one_disk(int mdfd, mdu_array_info_t *ainf,
417 mdu_disk_info_t *disk);
418
419 #if __GNUC__ < 3
420 struct stat64;
421 #endif
422
423 #define HAVE_NFTW we assume
424 #define HAVE_FTW
425
426 #ifdef UCLIBC
427 # include <features.h>
428 # ifndef __UCLIBC_HAS_FTW__
429 # undef HAVE_FTW
430 # undef HAVE_NFTW
431 # endif
432 #endif
433
434 #ifdef __dietlibc__
435 # undef HAVE_NFTW
436 #endif
437
438 #if defined(__KLIBC__)
439 # undef HAVE_NFTW
440 # undef HAVE_FTW
441 #endif
442
443 #ifndef HAVE_NFTW
444 # define FTW_PHYS 1
445 # ifndef HAVE_FTW
446 struct FTW {};
447 # endif
448 #endif
449
450 #ifdef HAVE_FTW
451 # include <ftw.h>
452 #endif
453
454 extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
455
456
457 extern int Manage_ro(char *devname, int fd, int readonly);
458 extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
459 extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
460 extern int Manage_reconfig(char *devname, int fd, int layout);
461 extern int Manage_subdevs(char *devname, int fd,
462 mddev_dev_t devlist, int verbose);
463 extern int autodetect(void);
464 extern int Grow_Add_device(char *devname, int fd, char *newdev);
465 extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
466 extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
467 long long size,
468 int level, int layout, int chunksize, int raid_disks);
469 extern int Grow_restart(struct supertype *st, struct mdinfo *info,
470 int *fdlist, int cnt, char *backup_file);
471
472
473 extern int Assemble(struct supertype *st, char *mddev, int mdfd,
474 mddev_ident_t ident,
475 mddev_dev_t devlist, char *backup_file,
476 int readonly, int runstop,
477 char *update, char *homehost,
478 int verbose, int force);
479
480 extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
481 int raiddisks,
482 mddev_dev_t devlist, int assume_clean,
483 char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int verbose);
484
485
486 extern int Create(struct supertype *st, char *mddev, int mdfd,
487 int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
488 char *name, char *homehost, int *uuid,
489 int subdevs, mddev_dev_t devlist,
490 int runstop, int verbose, int force, int assume_clean,
491 char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
492
493 extern int Detail(char *dev, int brief, int export, int test, char *homehost);
494 extern int Query(char *dev);
495 extern int Examine(mddev_dev_t devlist, int brief, int export, int scan,
496 int SparcAdjust, struct supertype *forcest, char *homehost);
497 extern int Monitor(mddev_dev_t devlist,
498 char *mailaddr, char *alert_cmd,
499 int period, int daemonise, int scan, int oneshot,
500 int dosyslog, int test, char *pidfile);
501
502 extern int Kill(char *dev, int force, int quiet, int noexcl);
503 extern int Wait(char *dev);
504
505 extern int Incremental(char *devname, int verbose, int runstop,
506 struct supertype *st, char *homehost, int autof);
507 extern int Incremental_container(struct supertype *st, char *devname,
508 int verbose, int runstop, int autof);
509 extern void RebuildMap(void);
510 extern int IncrementalScan(int verbose);
511
512 extern int CreateBitmap(char *filename, int force, char uuid[16],
513 unsigned long chunksize, unsigned long daemon_sleep,
514 unsigned long write_behind,
515 unsigned long long array_size,
516 int major);
517 extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
518 extern int bitmap_update_uuid(int fd, int *uuid, int swap);
519
520 extern int md_get_version(int fd);
521 extern int get_linux_version(void);
522 extern int parse_uuid(char *str, int uuid[4]);
523 extern int check_ext2(int fd, char *name);
524 extern int check_reiser(int fd, char *name);
525 extern int check_raid(int fd, char *name);
526
527 extern int get_mdp_major(void);
528 extern int dev_open(char *dev, int flags);
529 extern int is_standard(char *dev, int *nump);
530
531 extern int parse_auto(char *str, char *msg, int config);
532 extern mddev_ident_t conf_get_ident(char *dev);
533 extern mddev_dev_t conf_get_devs(void);
534 extern int conf_test_dev(char *devname);
535 extern struct createinfo *conf_get_create_info(void);
536 extern void set_conffile(char *file);
537 extern char *conf_get_mailaddr(void);
538 extern char *conf_get_mailfrom(void);
539 extern char *conf_get_program(void);
540 extern char *conf_get_homehost(void);
541 extern char *conf_line(FILE *file);
542 extern char *conf_word(FILE *file, int allow_key);
543 extern void free_line(char *line);
544 extern int match_oneof(char *devices, char *devname);
545 extern void uuid_from_super(int uuid[4], mdp_super_t *super);
546 extern int same_uuid(int a[4], int b[4], int swapuuid);
547 extern void copy_uuid(void *a, int b[4], int swapuuid);
548 extern unsigned long calc_csum(void *super, int bytes);
549 extern int enough(int level, int raid_disks, int layout, int clean,
550 char *avail, int avail_disks);
551 extern int ask(char *mesg);
552 extern unsigned long long get_component_size(int fd);
553 extern void remove_partitions(int fd);
554 extern unsigned long long calc_array_size(int level, int raid_disks, int layout,
555 int chunksize, unsigned long long devsize);
556
557
558 extern char *human_size(long long bytes);
559 char *human_size_brief(long long bytes);
560
561 #define NoMdDev (1<<23)
562 extern int find_free_devnum(int use_partitions);
563
564 extern void put_md_name(char *name);
565 extern char *get_md_name(int dev);
566
567 extern char DefaultConfFile[];
568
569 extern int open_mddev(char *dev, int autof);
570 extern int open_mddev_devnum(char *devname, int devnum, char *name,
571 char *chosen_name, int parts);
572 extern int open_container(int fd);
573
574 extern char *devnum2devname(int num);
575 extern int fd2devnum(int fd);
576
577 #define LEVEL_MULTIPATH (-4)
578 #define LEVEL_LINEAR (-1)
579 #define LEVEL_FAULTY (-5)
580
581 /* kernel module doesn't know about these */
582 #define LEVEL_CONTAINER (-100)
583 #define LEVEL_UNSUPPORTED (-200)
584
585
586 /* faulty stuff */
587
588 #define WriteTransient 0
589 #define ReadTransient 1
590 #define WritePersistent 2
591 #define ReadPersistent 3
592 #define WriteAll 4 /* doesn't go to device */
593 #define ReadFixable 5
594 #define Modes 6
595
596 #define ClearErrors 31
597 #define ClearFaults 30
598
599 #define AllPersist 100 /* internal use only */
600 #define NoPersist 101
601
602 #define ModeMask 0x1f
603 #define ModeShift 5
604
605
606 #ifdef __TINYC__
607 #undef minor
608 #undef major
609 #undef makedev
610 #define minor(x) ((x)&0xff)
611 #define major(x) (((x)>>8)&0xff)
612 #define makedev(M,m) (((M)<<8) | (m))
613 #endif
614
615 /* for raid5 */
616 #define ALGORITHM_LEFT_ASYMMETRIC 0
617 #define ALGORITHM_RIGHT_ASYMMETRIC 1
618 #define ALGORITHM_LEFT_SYMMETRIC 2
619 #define ALGORITHM_RIGHT_SYMMETRIC 3