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