]> git.ipfire.org Git - thirdparty/mdadm.git/blame - mdadm.h
Put a 'canary' block in front of the backup
[thirdparty/mdadm.git] / mdadm.h
CommitLineData
64c4757e 1/*
9a9dab36 2 * mdadm - manage Linux "md" devices aka RAID arrays.
64c4757e 3 *
cd29a5c8 4 * Copyright (C) 2001-2002 Neil Brown <neilb@cse.unsw.edu.au>
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
30#define __USE_LARGEFILE64
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];
353632d9
NB
94 unsigned long long data_offset;
95 unsigned long long component_size;
96 int reshape_active;
97 unsigned long long reshape_progress;
98 int new_level, delta_disks, new_layout, new_chunk;
4b1ac34b
NB
99};
100
9a9dab36 101#define Name "mdadm"
682c7051 102
e0d19036
NB
103enum mode {
104 ASSEMBLE=1,
105 BUILD,
106 CREATE,
107 MANAGE,
108 MISC,
109 MONITOR,
dd0781e5 110 GROW,
e0d19036
NB
111};
112
64c4757e 113extern char short_options[];
c06487ce 114extern char short_bitmap_auto_options[];
64c4757e 115extern struct option long_options[];
56eedc1a 116extern char Version[], Usage[], Help[], OptionHelp[],
dd0781e5 117 Help_create[], Help_build[], Help_assemble[], Help_grow[],
e0d19036 118 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e
NB
119
120/* structures read from config file */
52826846
NB
121/* List of mddevice names and identifiers
122 * Identifiers can be:
123 * uuid=128-hex-uuid
124 * super-minor=decimal-minor-number-from-superblock
125 * devices=comma,separated,list,of,device,names,with,wildcards
126 *
127 * If multiple fields are present, the intersection of all matching
128 * devices is considered
129 */
98c6faba 130#define UnSet (0xfffe)
52826846 131typedef struct mddev_ident_s {
dd0781e5 132 char *devname;
52826846 133
dd0781e5 134 int uuid_set;
3fa06e9d 135 int uuid[4];
947fd4dd 136 char name[33];
52826846 137
98c6faba 138 unsigned int super_minor;
52826846 139
dd0781e5 140 char *devices; /* comma separated list of device
52826846
NB
141 * names with wild cards
142 */
dd0781e5 143 int level;
98c6faba
NB
144 unsigned int raid_disks;
145 unsigned int spare_disks;
82d9eba6 146 struct supertype *st;
dd0781e5
NB
147 int autof; /* 1 for normal, 2 for partitioned */
148 char *spare_group;
c82f047c 149 int bitmap_fd;
dd0781e5 150
52826846
NB
151 struct mddev_ident_s *next;
152} *mddev_ident_t;
64c4757e
NB
153
154/* List of device names - wildcards expanded */
155typedef struct mddev_dev_s {
156 char *devname;
cd29a5c8
NB
157 char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
158 * Not set for names read from .config
159 */
dfd4d8ee 160 char writemostly;
fe80f49b 161 char re_add;
64c4757e
NB
162 struct mddev_dev_s *next;
163} *mddev_dev_t;
164
682c7051
NB
165typedef struct mapping {
166 char *name;
167 int num;
168} mapping_t;
169
e0d19036
NB
170
171struct mdstat_ent {
172 char *dev;
173 int devnum;
174 int active;
175 char *level;
176 char *pattern; /* U or up, _ for down */
177 int percent; /* -1 if no resync */
e5329c37 178 int resync; /* 1 if resync, 0 if recovery */
e0d19036
NB
179 struct mdstat_ent *next;
180};
181
22a88995 182extern struct mdstat_ent *mdstat_read(int hold, int start);
e0d19036 183extern void free_mdstat(struct mdstat_ent *ms);
dd0781e5 184extern void mdstat_wait(int seconds);
e0d19036 185
e86c9dd6
NB
186/* Data structure for holding info read from sysfs */
187struct sysdev {
188 char name[20];
189 int role;
190 int major, minor;
191 unsigned long long offset, size;
192 int state;
193 int errors;
194 struct sysdev *next;
195};
196struct sysarray {
197 char name[20];
198 struct sysdev *devs;
199 int chunk;
200 unsigned long long component_size;
201 int layout;
202 int level;
203 int spares;
204};
205/* various details can be requested */
206#define GET_LEVEL 1
207#define GET_LAYOUT 2
208#define GET_COMPONENT 4
209#define GET_CHUNK 8
210
211#define GET_DEVS 1024 /* gets role, major, minor */
212#define GET_OFFSET 2048
213#define GET_SIZE 4096
214#define GET_STATE 8192
215#define GET_ERROR 16384
216
217/* If fd >= 0, get the array it is open on,
218 * else use devnum. >=0 -> major9. <0.....
219 */
220extern struct sysarray *sysfs_read(int fd, int devnum, unsigned long options);
221extern int sysfs_set_str(struct sysarray *sra, struct sysdev *dev,
222 char *name, char *val);
223extern int sysfs_set_num(struct sysarray *sra, struct sysdev *dev,
224 char *name, unsigned long long val);
225extern int sysfs_get_ll(struct sysarray *sra, struct sysdev *dev,
226 char *name, unsigned long long *val);
227
228
229extern int save_stripes(int *source, unsigned long long *offsets,
230 int raid_disks, int chunk_size, int level, int layout,
231 int nwrites, int *dest,
232 unsigned long long start, unsigned long long length);
353632d9
NB
233extern int restore_stripes(int *dest, unsigned long long *offsets,
234 int raid_disks, int chunk_size, int level, int layout,
235 int source, unsigned long long read_offset,
236 unsigned long long start, unsigned long long length);
e86c9dd6 237
52826846
NB
238#ifndef Sendmail
239#define Sendmail "/usr/lib/sendmail -t"
240#endif
241
773135f5
NB
242#define SYSLOG_FACILITY LOG_DAEMON
243
682c7051
NB
244extern char *map_num(mapping_t *map, int num);
245extern int map_name(mapping_t *map, char *name);
b5e64645 246extern mapping_t r5layout[], pers[], modes[], faultylayout[];
682c7051 247
82b27616 248extern char *map_dev(int major, int minor);
64c4757e
NB
249
250
f9ce90ba
NB
251extern struct superswitch {
252 void (*examine_super)(void *sbv);
253 void (*brief_examine_super)(void *sbv);
254 void (*detail_super)(void *sbv);
255 void (*brief_detail_super)(void *sbv);
256 void (*uuid_from_super)(int uuid[4], void *sbv);
947fd4dd 257 void (*getinfo_super)(struct mdinfo *info, mddev_ident_t ident, void *sbv);
f9ce90ba
NB
258 int (*update_super)(struct mdinfo *info, void *sbv, char *update, char *devname, int verbose);
259 __u64 (*event_super)(void *sbv);
5dd497ee 260 int (*init_super)(struct supertype *st, void **sbp, mdu_array_info_t *info, unsigned long long size, char *name);
f9ce90ba 261 void (*add_to_super)(void *sbv, mdu_disk_info_t *dinfo);
96395475 262 int (*store_super)(struct supertype *st, int fd, void *sbv);
1bf4e2d9 263 int (*write_init_super)(struct supertype *st, void *sbv, mdu_disk_info_t *dinfo, char *devname);
f9ce90ba 264 int (*compare_super)(void **firstp, void *secondv);
82d9eba6
NB
265 int (*load_super)(struct supertype *st, int fd, void **sbp, char *devname);
266 struct supertype * (*match_metadata_desc)(char *arg);
1bf4e2d9 267 __u64 (*avail_size)(struct supertype *st, __u64 size);
f9c25f1d
NB
268 int (*add_internal_bitmap)(struct supertype *st, void *sbv, int chunk, int delay, int write_behind,
269 unsigned long long size, int may_change, int major);
f6d75de8 270 void (*locate_bitmap)(struct supertype *st, int fd, void *sbv);
f5e166fe 271 int (*write_bitmap)(struct supertype *st, int fd, void *sbv);
82d9eba6 272 int major;
f277ce36 273 int swapuuid; /* true if uuid is bigending rather than hostendian */
82d9eba6
NB
274} super0, super1, *superlist[];
275
276struct supertype {
277 struct superswitch *ss;
278 int minor_version;
ea329559 279 int max_devs;
82d9eba6 280};
f9ce90ba 281
82d9eba6
NB
282extern struct supertype *super_by_version(int vers, int minor);
283extern struct supertype *guess_super(int fd);
f9ce90ba 284
838acbc2
NB
285#if __GNUC__ < 3
286struct stat64;
287#endif
288
173fc515
NB
289#ifdef UCLIBC
290 struct FTW {};
291# define FTW_PHYS 1
292#else
293# define __USE_XOPEN_EXTENDED
294# include <ftw.h>
295# ifdef __dietlibc__
296# define FTW_PHYS 1
297# endif
298#endif
299
300extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
301
f9ce90ba 302
64c4757e 303extern int Manage_ro(char *devname, int fd, int readonly);
91f068bf 304extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
dd0781e5 305extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
b5e64645 306extern int Manage_reconfig(char *devname, int fd, int layout);
64c4757e 307extern int Manage_subdevs(char *devname, int fd,
dab6685f 308 mddev_dev_t devlist, int verbose);
e5329c37 309extern int Grow_Add_device(char *devname, int fd, char *newdev);
8fac0577 310extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
e86c9dd6
NB
311extern int Grow_reshape(char *devname, int fd, int quiet,
312 long long size,
313 int level, int layout, int chunksize, int raid_disks);
353632d9 314extern int Grow_restart(struct supertype *st, struct mdinfo *info, int *fdlist, int cnt);
64c4757e
NB
315
316
82d9eba6 317extern int Assemble(struct supertype *st, char *mddev, int mdfd,
52826846
NB
318 mddev_ident_t ident,
319 char *conffile,
cd29a5c8 320 mddev_dev_t devlist,
64c4757e 321 int readonly, int runstop,
5787fa49 322 char *update,
64c4757e
NB
323 int verbose, int force);
324
b5e64645 325extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
64c4757e 326 int raiddisks,
c82f047c 327 mddev_dev_t devlist, int assume_clean,
dab6685f 328 char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int verbose);
64c4757e
NB
329
330
82d9eba6 331extern int Create(struct supertype *st, char *mddev, int mdfd,
5dd497ee 332 int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
947fd4dd 333 char *name,
cd29a5c8 334 int subdevs, mddev_dev_t devlist,
47d79ef8 335 int runstop, int verbose, int force, int assume_clean,
dfd4d8ee 336 char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
64c4757e 337
feb716e9 338extern int Detail(char *dev, int brief, int test);
e0d19036 339extern int Query(char *dev);
82d9eba6
NB
340extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
341 struct supertype *forcest);
cd29a5c8 342extern int Monitor(mddev_dev_t devlist,
e0d19036 343 char *mailaddr, char *alert_cmd,
aa88f531 344 int period, int daemonise, int scan, int oneshot,
773135f5 345 int dosyslog, char *config, int test, char *pidfile);
64c4757e 346
9a9dab36
NB
347extern int Kill(char *dev, int force);
348
c82f047c
NB
349extern int CreateBitmap(char *filename, int force, char uuid[16],
350 unsigned long chunksize, unsigned long daemon_sleep,
dfd4d8ee 351 unsigned long write_behind,
dcec9ee5
NB
352 unsigned long long array_size,
353 int major);
55935d51 354extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
c82f047c 355
64c4757e 356extern int md_get_version(int fd);
e0d19036 357extern int get_linux_version(void);
64c4757e 358extern int parse_uuid(char *str, int uuid[4]);
682c7051
NB
359extern int check_ext2(int fd, char *name);
360extern int check_reiser(int fd, char *name);
361extern int check_raid(int fd, char *name);
64c4757e 362
dd0781e5 363extern int get_mdp_major(void);
8b0dabea 364extern int dev_open(char *dev, int flags);
8d80900b 365extern int is_standard(char *dev, int *nump);
dd0781e5
NB
366
367
e0d19036
NB
368extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
369extern mddev_dev_t conf_get_devs(char *conffile);
370extern char *conf_get_mailaddr(char *conffile);
371extern char *conf_get_program(char *conffile);
372extern char *conf_line(FILE *file);
98c6faba 373extern char *conf_word(FILE *file, int allow_key);
e0d19036
NB
374extern void free_line(char *line);
375extern int match_oneof(char *devices, char *devname);
e0d19036 376extern void uuid_from_super(int uuid[4], mdp_super_t *super);
f277ce36 377extern int same_uuid(int a[4], int b[4], int swapuuid);
4b1ac34b
NB
378/* extern int compare_super(mdp_super_t *first, mdp_super_t *second);*/
379extern unsigned long calc_csum(void *super, int bytes);
265e0f17
NB
380extern int enough(int level, int raid_disks, int layout,
381 char *avail, int avail_disks);
e0d19036 382extern int ask(char *mesg);
8fac0577 383extern unsigned long long get_component_size(int fd);
e0d19036 384
cd29a5c8 385
56eb10c0 386extern char *human_size(long long bytes);
e0d19036
NB
387char *human_size_brief(long long bytes);
388
389extern void put_md_name(char *name);
390extern char *get_md_name(int dev);
391
c913b90e 392extern char DefaultConfFile[];
b5e64645
NB
393
394extern int open_mddev(char *dev, int autof);
395
396
397#define LEVEL_MULTIPATH (-4)
398#define LEVEL_LINEAR (-1)
399#define LEVEL_FAULTY (-5)
400
401
402/* faulty stuff */
403
404#define WriteTransient 0
405#define ReadTransient 1
406#define WritePersistent 2
407#define ReadPersistent 3
408#define WriteAll 4 /* doesn't go to device */
409#define ReadFixable 5
410#define Modes 6
411
412#define ClearErrors 31
413#define ClearFaults 30
414
415#define AllPersist 100 /* internal use only */
416#define NoPersist 101
417
418#define ModeMask 0x1f
419#define ModeShift 5
fe6729fa
NB
420
421
422#ifdef __TINYC__
423#undef minor
424#undef major
425#undef makedev
426#define minor(x) ((x)&0xff)
427#define major(x) (((x)>>8)&0xff)
428#define makedev(M,m) (((M)<<8) | (m))
429#endif
430
e86c9dd6
NB
431/* for raid5 */
432#define ALGORITHM_LEFT_ASYMMETRIC 0
433#define ALGORITHM_RIGHT_ASYMMETRIC 1
434#define ALGORITHM_LEFT_SYMMETRIC 2
435#define ALGORITHM_RIGHT_SYMMETRIC 3