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