]> git.ipfire.org Git - thirdparty/mdadm.git/blame - mdadm.h
Make sure name matching for array assembly understand the possibility of a homehost
[thirdparty/mdadm.git] / mdadm.h
CommitLineData
64c4757e 1/*
9a9dab36 2 * mdadm - manage Linux "md" devices aka RAID arrays.
64c4757e 3 *
4f589ad0 4 * Copyright (C) 2001-2006 Neil Brown <neilb@suse.de>
64c4757e
NB
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
4ccdb956 30#define _GNU_SOURCE
64c4757e 31#include <unistd.h>
98c6faba 32#ifndef __dietlibc__
64c4757e 33extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
98c6faba 34#endif
64c4757e
NB
35
36#include <sys/types.h>
37#include <sys/stat.h>
38#include <stdlib.h>
39#include <time.h>
11018a45 40#include <sys/time.h>
64c4757e
NB
41#include <getopt.h>
42#include <fcntl.h>
43#include <stdio.h>
44#include <errno.h>
45#include <string.h>
773135f5 46#include <syslog.h>
98c6faba
NB
47#ifdef __dietlibc__NONO
48int strncmp(const char *s1, const char *s2, size_t n) __THROW __pure__;
49char *strncpy(char *dest, const char *src, size_t n) __THROW;
50#include <strings.h>
51#endif
52
64c4757e
NB
53
54#include <linux/kdev_t.h>
e0d19036
NB
55/*#include <linux/fs.h> */
56#include <sys/mount.h>
57#include <asm/types.h>
64c4757e
NB
58#include <sys/ioctl.h>
59#define MD_MAJOR 9
dd0781e5 60#define MdpMinorShift 6
64c4757e 61
e0d19036 62#ifndef BLKGETSIZE64
98c6faba 63#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
e0d19036 64#endif
56eb10c0 65
c82f047c
NB
66#define DEFAULT_BITMAP_CHUNK 4096
67#define DEFAULT_BITMAP_DELAY 5
dfd4d8ee 68#define DEFAULT_MAX_WRITE_BEHIND 256
64c4757e
NB
69
70#include "md_u.h"
e0d19036 71#include "md_p.h"
c82f047c 72#include "bitmap.h"
64c4757e 73
1e0d770c
NB
74#include <endian.h>
75/* #include "asm/byteorder.h" Redhat don't like this so... */
76#if __BYTE_ORDER == __LITTLE_ENDIAN
77# include <linux/byteorder/little_endian.h>
78#elif __BYTE_ORDER == __BIG_ENDIAN
79# include <linux/byteorder/big_endian.h>
80#elif __BYTE_ORDER == __PDP_ENDIAN
81# include <linux/byteorder/pdp_endian.h>
82#else
83# error "unknown endianness."
84#endif
85
86
87
4b1ac34b
NB
88/* general information that might be extracted from a superblock */
89struct mdinfo {
90 mdu_array_info_t array;
91 mdu_disk_info_t disk;
92 __u64 events;
fbf8a0b7 93 int uuid[4];
31317663 94 char name[33];
353632d9
NB
95 unsigned long long data_offset;
96 unsigned long long component_size;
97 int reshape_active;
98 unsigned long long reshape_progress;
99 int new_level, delta_disks, new_layout, new_chunk;
4b1ac34b
NB
100};
101
5bbb4842
NB
102struct createinfo {
103 int uid;
104 int gid;
105 int autof;
106 int mode;
107};
108
9a9dab36 109#define Name "mdadm"
682c7051 110
e0d19036
NB
111enum mode {
112 ASSEMBLE=1,
113 BUILD,
114 CREATE,
115 MANAGE,
116 MISC,
117 MONITOR,
dd0781e5 118 GROW,
e0d19036
NB
119};
120
64c4757e 121extern char short_options[];
c06487ce 122extern char short_bitmap_auto_options[];
64c4757e 123extern struct option long_options[];
56eedc1a 124extern char Version[], Usage[], Help[], OptionHelp[],
dd0781e5 125 Help_create[], Help_build[], Help_assemble[], Help_grow[],
e0d19036 126 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e 127
997aed5d
NB
128/* for option that don't have short equivilents, we assign arbitrary
129 * small numbers. '1' means an undecorated option, so we start at '2'.
130 */
131enum special_options {
132 AssumeClean = 2,
133 BitmapChunk,
134 WriteBehind,
135 ReAdd,
136 NoDegraded,
137 Sparc22,
138 BackupFile,
139 HomeHost,
140};
141
64c4757e 142/* structures read from config file */
52826846
NB
143/* List of mddevice names and identifiers
144 * Identifiers can be:
145 * uuid=128-hex-uuid
146 * super-minor=decimal-minor-number-from-superblock
147 * devices=comma,separated,list,of,device,names,with,wildcards
148 *
149 * If multiple fields are present, the intersection of all matching
150 * devices is considered
151 */
98c6faba 152#define UnSet (0xfffe)
52826846 153typedef struct mddev_ident_s {
dd0781e5 154 char *devname;
52826846 155
dd0781e5 156 int uuid_set;
3fa06e9d 157 int uuid[4];
947fd4dd 158 char name[33];
52826846 159
98c6faba 160 unsigned int super_minor;
52826846 161
dd0781e5 162 char *devices; /* comma separated list of device
52826846
NB
163 * names with wild cards
164 */
dd0781e5 165 int level;
98c6faba
NB
166 unsigned int raid_disks;
167 unsigned int spare_disks;
82d9eba6 168 struct supertype *st;
dd0781e5
NB
169 int autof; /* 1 for normal, 2 for partitioned */
170 char *spare_group;
7ef02d01 171 char *bitmap_file;
c82f047c 172 int bitmap_fd;
dd0781e5 173
52826846
NB
174 struct mddev_ident_s *next;
175} *mddev_ident_t;
64c4757e
NB
176
177/* List of device names - wildcards expanded */
178typedef struct mddev_dev_s {
179 char *devname;
cd29a5c8
NB
180 char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
181 * Not set for names read from .config
182 */
dfd4d8ee 183 char writemostly;
fe80f49b 184 char re_add;
64c4757e
NB
185 struct mddev_dev_s *next;
186} *mddev_dev_t;
187
682c7051
NB
188typedef struct mapping {
189 char *name;
190 int num;
191} mapping_t;
192
e0d19036
NB
193
194struct mdstat_ent {
195 char *dev;
196 int devnum;
197 int active;
198 char *level;
199 char *pattern; /* U or up, _ for down */
200 int percent; /* -1 if no resync */
e5329c37 201 int resync; /* 1 if resync, 0 if recovery */
e0d19036
NB
202 struct mdstat_ent *next;
203};
204
22a88995 205extern struct mdstat_ent *mdstat_read(int hold, int start);
e0d19036 206extern void free_mdstat(struct mdstat_ent *ms);
dd0781e5 207extern void mdstat_wait(int seconds);
e0d19036 208
e86c9dd6
NB
209/* Data structure for holding info read from sysfs */
210struct sysdev {
211 char name[20];
212 int role;
213 int major, minor;
214 unsigned long long offset, size;
215 int state;
216 int errors;
217 struct sysdev *next;
218};
219struct sysarray {
220 char name[20];
221 struct sysdev *devs;
222 int chunk;
223 unsigned long long component_size;
224 int layout;
225 int level;
226 int spares;
227};
228/* various details can be requested */
229#define GET_LEVEL 1
230#define GET_LAYOUT 2
231#define GET_COMPONENT 4
232#define GET_CHUNK 8
233
234#define GET_DEVS 1024 /* gets role, major, minor */
235#define GET_OFFSET 2048
236#define GET_SIZE 4096
237#define GET_STATE 8192
238#define GET_ERROR 16384
239
240/* If fd >= 0, get the array it is open on,
241 * else use devnum. >=0 -> major9. <0.....
242 */
243extern struct sysarray *sysfs_read(int fd, int devnum, unsigned long options);
244extern int sysfs_set_str(struct sysarray *sra, struct sysdev *dev,
245 char *name, char *val);
246extern int sysfs_set_num(struct sysarray *sra, struct sysdev *dev,
247 char *name, unsigned long long val);
248extern int sysfs_get_ll(struct sysarray *sra, struct sysdev *dev,
249 char *name, unsigned long long *val);
250
251
252extern int save_stripes(int *source, unsigned long long *offsets,
253 int raid_disks, int chunk_size, int level, int layout,
254 int nwrites, int *dest,
255 unsigned long long start, unsigned long long length);
353632d9
NB
256extern int restore_stripes(int *dest, unsigned long long *offsets,
257 int raid_disks, int chunk_size, int level, int layout,
258 int source, unsigned long long read_offset,
259 unsigned long long start, unsigned long long length);
e86c9dd6 260
52826846
NB
261#ifndef Sendmail
262#define Sendmail "/usr/lib/sendmail -t"
263#endif
264
773135f5
NB
265#define SYSLOG_FACILITY LOG_DAEMON
266
682c7051
NB
267extern char *map_num(mapping_t *map, int num);
268extern int map_name(mapping_t *map, char *name);
b5e64645 269extern mapping_t r5layout[], pers[], modes[], faultylayout[];
682c7051 270
16c6fa80 271extern char *map_dev(int major, int minor, int create);
64c4757e
NB
272
273
f9ce90ba 274extern struct superswitch {
a1cbd7d0 275 void (*examine_super)(void *sbv, char *homehost);
f9ce90ba 276 void (*brief_examine_super)(void *sbv);
b6750aa8 277 void (*detail_super)(void *sbv, char *homehost);
f9ce90ba
NB
278 void (*brief_detail_super)(void *sbv);
279 void (*uuid_from_super)(int uuid[4], void *sbv);
31317663 280 void (*getinfo_super)(struct mdinfo *info, void *sbv);
e5eac01f
NB
281 int (*update_super)(struct mdinfo *info, void *sbv, char *update,
282 char *devname, int verbose,
283 int uuid_set, char *homehost);
f9ce90ba 284 __u64 (*event_super)(void *sbv);
05697ec1 285 int (*init_super)(struct supertype *st, void **sbp, mdu_array_info_t *info, unsigned long long size, char *name, char *homehost);
f9ce90ba 286 void (*add_to_super)(void *sbv, mdu_disk_info_t *dinfo);
96395475 287 int (*store_super)(struct supertype *st, int fd, void *sbv);
1bf4e2d9 288 int (*write_init_super)(struct supertype *st, void *sbv, mdu_disk_info_t *dinfo, char *devname);
f9ce90ba 289 int (*compare_super)(void **firstp, void *secondv);
82d9eba6
NB
290 int (*load_super)(struct supertype *st, int fd, void **sbp, char *devname);
291 struct supertype * (*match_metadata_desc)(char *arg);
1bf4e2d9 292 __u64 (*avail_size)(struct supertype *st, __u64 size);
f9c25f1d
NB
293 int (*add_internal_bitmap)(struct supertype *st, void *sbv, int chunk, int delay, int write_behind,
294 unsigned long long size, int may_change, int major);
f6d75de8 295 void (*locate_bitmap)(struct supertype *st, int fd, void *sbv);
f5e166fe 296 int (*write_bitmap)(struct supertype *st, int fd, void *sbv);
82d9eba6 297 int major;
f277ce36 298 int swapuuid; /* true if uuid is bigending rather than hostendian */
82d9eba6
NB
299} super0, super1, *superlist[];
300
301struct supertype {
302 struct superswitch *ss;
303 int minor_version;
ea329559 304 int max_devs;
82d9eba6 305};
f9ce90ba 306
82d9eba6
NB
307extern struct supertype *super_by_version(int vers, int minor);
308extern struct supertype *guess_super(int fd);
f9ce90ba 309
838acbc2
NB
310#if __GNUC__ < 3
311struct stat64;
312#endif
313
173fc515
NB
314#ifdef UCLIBC
315 struct FTW {};
316# define FTW_PHYS 1
317#else
173fc515
NB
318# include <ftw.h>
319# ifdef __dietlibc__
320# define FTW_PHYS 1
321# endif
322#endif
323
324extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
325
f9ce90ba 326
64c4757e 327extern int Manage_ro(char *devname, int fd, int readonly);
91f068bf 328extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
dd0781e5 329extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
b5e64645 330extern int Manage_reconfig(char *devname, int fd, int layout);
64c4757e 331extern int Manage_subdevs(char *devname, int fd,
dab6685f 332 mddev_dev_t devlist, int verbose);
e5329c37 333extern int Grow_Add_device(char *devname, int fd, char *newdev);
8fac0577 334extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
06b0d786 335extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
e86c9dd6
NB
336 long long size,
337 int level, int layout, int chunksize, int raid_disks);
06b0d786
NB
338extern int Grow_restart(struct supertype *st, struct mdinfo *info,
339 int *fdlist, int cnt, char *backup_file);
64c4757e
NB
340
341
82d9eba6 342extern int Assemble(struct supertype *st, char *mddev, int mdfd,
52826846
NB
343 mddev_ident_t ident,
344 char *conffile,
06b0d786 345 mddev_dev_t devlist, char *backup_file,
64c4757e 346 int readonly, int runstop,
e5eac01f 347 char *update, char *homehost,
64c4757e
NB
348 int verbose, int force);
349
b5e64645 350extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
64c4757e 351 int raiddisks,
c82f047c 352 mddev_dev_t devlist, int assume_clean,
dab6685f 353 char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int verbose);
64c4757e
NB
354
355
82d9eba6 356extern int Create(struct supertype *st, char *mddev, int mdfd,
5dd497ee 357 int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
05697ec1 358 char *name, char *homehost,
cd29a5c8 359 int subdevs, mddev_dev_t devlist,
47d79ef8 360 int runstop, int verbose, int force, int assume_clean,
dfd4d8ee 361 char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
64c4757e 362
b6750aa8 363extern int Detail(char *dev, int brief, int test, char *homehost);
e0d19036 364extern int Query(char *dev);
82d9eba6 365extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
a1cbd7d0 366 struct supertype *forcest, char *homehost);
cd29a5c8 367extern int Monitor(mddev_dev_t devlist,
e0d19036 368 char *mailaddr, char *alert_cmd,
aa88f531 369 int period, int daemonise, int scan, int oneshot,
773135f5 370 int dosyslog, char *config, int test, char *pidfile);
64c4757e 371
6409687b 372extern int Kill(char *dev, int force, int quiet);
9a9dab36 373
c82f047c
NB
374extern int CreateBitmap(char *filename, int force, char uuid[16],
375 unsigned long chunksize, unsigned long daemon_sleep,
dfd4d8ee 376 unsigned long write_behind,
dcec9ee5
NB
377 unsigned long long array_size,
378 int major);
55935d51 379extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
8131b493 380extern void bitmap_update_uuid(int fd, int *uuid);
c82f047c 381
64c4757e 382extern int md_get_version(int fd);
e0d19036 383extern int get_linux_version(void);
64c4757e 384extern int parse_uuid(char *str, int uuid[4]);
682c7051
NB
385extern int check_ext2(int fd, char *name);
386extern int check_reiser(int fd, char *name);
387extern int check_raid(int fd, char *name);
64c4757e 388
dd0781e5 389extern int get_mdp_major(void);
8b0dabea 390extern int dev_open(char *dev, int flags);
8d80900b 391extern int is_standard(char *dev, int *nump);
dd0781e5 392
f1ae21c4 393extern int parse_auto(char *str, char *msg, int config);
e0d19036
NB
394extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
395extern mddev_dev_t conf_get_devs(char *conffile);
5bbb4842 396extern struct createinfo *conf_get_create_info(char *conffile);
e0d19036 397extern char *conf_get_mailaddr(char *conffile);
4948b8f7 398extern char *conf_get_mailfrom(char *conffile);
e0d19036 399extern char *conf_get_program(char *conffile);
997aed5d 400extern char *conf_get_homehost(char *conffile);
e0d19036 401extern char *conf_line(FILE *file);
98c6faba 402extern char *conf_word(FILE *file, int allow_key);
e0d19036
NB
403extern void free_line(char *line);
404extern int match_oneof(char *devices, char *devname);
e0d19036 405extern void uuid_from_super(int uuid[4], mdp_super_t *super);
f277ce36 406extern int same_uuid(int a[4], int b[4], int swapuuid);
4b1ac34b
NB
407/* extern int compare_super(mdp_super_t *first, mdp_super_t *second);*/
408extern unsigned long calc_csum(void *super, int bytes);
265e0f17
NB
409extern int enough(int level, int raid_disks, int layout,
410 char *avail, int avail_disks);
e0d19036 411extern int ask(char *mesg);
8fac0577 412extern unsigned long long get_component_size(int fd);
e0d19036 413
cd29a5c8 414
56eb10c0 415extern char *human_size(long long bytes);
e0d19036
NB
416char *human_size_brief(long long bytes);
417
418extern void put_md_name(char *name);
419extern char *get_md_name(int dev);
420
c913b90e 421extern char DefaultConfFile[];
b5e64645
NB
422
423extern int open_mddev(char *dev, int autof);
424
425
426#define LEVEL_MULTIPATH (-4)
427#define LEVEL_LINEAR (-1)
428#define LEVEL_FAULTY (-5)
429
430
431/* faulty stuff */
432
433#define WriteTransient 0
434#define ReadTransient 1
435#define WritePersistent 2
436#define ReadPersistent 3
437#define WriteAll 4 /* doesn't go to device */
438#define ReadFixable 5
439#define Modes 6
440
441#define ClearErrors 31
442#define ClearFaults 30
443
444#define AllPersist 100 /* internal use only */
445#define NoPersist 101
446
447#define ModeMask 0x1f
448#define ModeShift 5
fe6729fa
NB
449
450
451#ifdef __TINYC__
452#undef minor
453#undef major
454#undef makedev
455#define minor(x) ((x)&0xff)
456#define major(x) (((x)>>8)&0xff)
457#define makedev(M,m) (((M)<<8) | (m))
458#endif
459
e86c9dd6
NB
460/* for raid5 */
461#define ALGORITHM_LEFT_ASYMMETRIC 0
462#define ALGORITHM_RIGHT_ASYMMETRIC 1
463#define ALGORITHM_LEFT_SYMMETRIC 2
464#define ALGORITHM_RIGHT_SYMMETRIC 3