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