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