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