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