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