]> git.ipfire.org Git - thirdparty/mdadm.git/blame - mdadm.h
Prefer version-1 superblocks for v.large devices.
[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
4b1ac34b
NB
74/* general information that might be extracted from a superblock */
75struct mdinfo {
76 mdu_array_info_t array;
77 mdu_disk_info_t disk;
78 __u64 events;
fbf8a0b7 79 int uuid[4];
4b1ac34b
NB
80};
81
9a9dab36 82#define Name "mdadm"
682c7051 83
e0d19036
NB
84enum mode {
85 ASSEMBLE=1,
86 BUILD,
87 CREATE,
88 MANAGE,
89 MISC,
90 MONITOR,
dd0781e5 91 GROW,
e0d19036
NB
92};
93
64c4757e 94extern char short_options[];
c06487ce 95extern char short_bitmap_auto_options[];
64c4757e 96extern struct option long_options[];
56eedc1a 97extern char Version[], Usage[], Help[], OptionHelp[],
dd0781e5 98 Help_create[], Help_build[], Help_assemble[], Help_grow[],
e0d19036 99 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e
NB
100
101/* structures read from config file */
52826846
NB
102/* List of mddevice names and identifiers
103 * Identifiers can be:
104 * uuid=128-hex-uuid
105 * super-minor=decimal-minor-number-from-superblock
106 * devices=comma,separated,list,of,device,names,with,wildcards
107 *
108 * If multiple fields are present, the intersection of all matching
109 * devices is considered
110 */
98c6faba 111#define UnSet (0xfffe)
52826846 112typedef struct mddev_ident_s {
dd0781e5 113 char *devname;
52826846 114
dd0781e5 115 int uuid_set;
3fa06e9d 116 int uuid[4];
947fd4dd 117 char name[33];
52826846 118
98c6faba 119 unsigned int super_minor;
52826846 120
dd0781e5 121 char *devices; /* comma separated list of device
52826846
NB
122 * names with wild cards
123 */
dd0781e5 124 int level;
98c6faba
NB
125 unsigned int raid_disks;
126 unsigned int spare_disks;
82d9eba6 127 struct supertype *st;
dd0781e5
NB
128 int autof; /* 1 for normal, 2 for partitioned */
129 char *spare_group;
c82f047c 130 int bitmap_fd;
dd0781e5 131
52826846
NB
132 struct mddev_ident_s *next;
133} *mddev_ident_t;
64c4757e
NB
134
135/* List of device names - wildcards expanded */
136typedef struct mddev_dev_s {
137 char *devname;
cd29a5c8
NB
138 char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
139 * Not set for names read from .config
140 */
dfd4d8ee 141 char writemostly;
fe80f49b 142 char re_add;
64c4757e
NB
143 struct mddev_dev_s *next;
144} *mddev_dev_t;
145
682c7051
NB
146typedef struct mapping {
147 char *name;
148 int num;
149} mapping_t;
150
e0d19036
NB
151
152struct mdstat_ent {
153 char *dev;
154 int devnum;
155 int active;
156 char *level;
157 char *pattern; /* U or up, _ for down */
158 int percent; /* -1 if no resync */
e5329c37 159 int resync; /* 1 if resync, 0 if recovery */
e0d19036
NB
160 struct mdstat_ent *next;
161};
162
dd0781e5 163extern struct mdstat_ent *mdstat_read(int);
e0d19036 164extern void free_mdstat(struct mdstat_ent *ms);
dd0781e5 165extern void mdstat_wait(int seconds);
e0d19036 166
52826846
NB
167#ifndef Sendmail
168#define Sendmail "/usr/lib/sendmail -t"
169#endif
170
773135f5
NB
171#define SYSLOG_FACILITY LOG_DAEMON
172
682c7051
NB
173extern char *map_num(mapping_t *map, int num);
174extern int map_name(mapping_t *map, char *name);
b5e64645 175extern mapping_t r5layout[], pers[], modes[], faultylayout[];
682c7051 176
82b27616 177extern char *map_dev(int major, int minor);
64c4757e
NB
178
179
f9ce90ba
NB
180extern struct superswitch {
181 void (*examine_super)(void *sbv);
182 void (*brief_examine_super)(void *sbv);
183 void (*detail_super)(void *sbv);
184 void (*brief_detail_super)(void *sbv);
185 void (*uuid_from_super)(int uuid[4], void *sbv);
947fd4dd 186 void (*getinfo_super)(struct mdinfo *info, mddev_ident_t ident, void *sbv);
f9ce90ba
NB
187 int (*update_super)(struct mdinfo *info, void *sbv, char *update, char *devname, int verbose);
188 __u64 (*event_super)(void *sbv);
5dd497ee 189 int (*init_super)(struct supertype *st, void **sbp, mdu_array_info_t *info, unsigned long long size, char *name);
f9ce90ba 190 void (*add_to_super)(void *sbv, mdu_disk_info_t *dinfo);
96395475 191 int (*store_super)(struct supertype *st, int fd, void *sbv);
1bf4e2d9 192 int (*write_init_super)(struct supertype *st, void *sbv, mdu_disk_info_t *dinfo, char *devname);
f9ce90ba 193 int (*compare_super)(void **firstp, void *secondv);
82d9eba6
NB
194 int (*load_super)(struct supertype *st, int fd, void **sbp, char *devname);
195 struct supertype * (*match_metadata_desc)(char *arg);
1bf4e2d9 196 __u64 (*avail_size)(struct supertype *st, __u64 size);
f9c25f1d
NB
197 int (*add_internal_bitmap)(struct supertype *st, void *sbv, int chunk, int delay, int write_behind,
198 unsigned long long size, int may_change, int major);
f6d75de8 199 void (*locate_bitmap)(struct supertype *st, int fd, void *sbv);
f5e166fe 200 int (*write_bitmap)(struct supertype *st, int fd, void *sbv);
82d9eba6 201 int major;
f277ce36 202 int swapuuid; /* true if uuid is bigending rather than hostendian */
82d9eba6
NB
203} super0, super1, *superlist[];
204
205struct supertype {
206 struct superswitch *ss;
207 int minor_version;
ea329559 208 int max_devs;
82d9eba6 209};
f9ce90ba 210
82d9eba6
NB
211extern struct supertype *super_by_version(int vers, int minor);
212extern struct supertype *guess_super(int fd);
f9ce90ba 213
838acbc2
NB
214#if __GNUC__ < 3
215struct stat64;
216#endif
217
173fc515
NB
218#ifdef UCLIBC
219 struct FTW {};
220# define FTW_PHYS 1
221#else
222# define __USE_XOPEN_EXTENDED
223# include <ftw.h>
224# ifdef __dietlibc__
225# define FTW_PHYS 1
226# endif
227#endif
228
229extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
230
f9ce90ba 231
64c4757e 232extern int Manage_ro(char *devname, int fd, int readonly);
91f068bf 233extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
dd0781e5 234extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
b5e64645 235extern int Manage_reconfig(char *devname, int fd, int layout);
64c4757e 236extern int Manage_subdevs(char *devname, int fd,
dab6685f 237 mddev_dev_t devlist, int verbose);
e5329c37 238extern int Grow_Add_device(char *devname, int fd, char *newdev);
8fac0577 239extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
64c4757e
NB
240
241
82d9eba6 242extern int Assemble(struct supertype *st, char *mddev, int mdfd,
52826846
NB
243 mddev_ident_t ident,
244 char *conffile,
cd29a5c8 245 mddev_dev_t devlist,
64c4757e 246 int readonly, int runstop,
5787fa49 247 char *update,
64c4757e
NB
248 int verbose, int force);
249
b5e64645 250extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
64c4757e 251 int raiddisks,
c82f047c 252 mddev_dev_t devlist, int assume_clean,
dab6685f 253 char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int verbose);
64c4757e
NB
254
255
82d9eba6 256extern int Create(struct supertype *st, char *mddev, int mdfd,
5dd497ee 257 int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
947fd4dd 258 char *name,
cd29a5c8 259 int subdevs, mddev_dev_t devlist,
47d79ef8 260 int runstop, int verbose, int force, int assume_clean,
dfd4d8ee 261 char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
64c4757e 262
feb716e9 263extern int Detail(char *dev, int brief, int test);
e0d19036 264extern int Query(char *dev);
82d9eba6
NB
265extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
266 struct supertype *forcest);
cd29a5c8 267extern int Monitor(mddev_dev_t devlist,
e0d19036 268 char *mailaddr, char *alert_cmd,
aa88f531 269 int period, int daemonise, int scan, int oneshot,
773135f5 270 int dosyslog, char *config, int test, char *pidfile);
64c4757e 271
9a9dab36
NB
272extern int Kill(char *dev, int force);
273
c82f047c
NB
274extern int CreateBitmap(char *filename, int force, char uuid[16],
275 unsigned long chunksize, unsigned long daemon_sleep,
dfd4d8ee 276 unsigned long write_behind,
dcec9ee5
NB
277 unsigned long long array_size,
278 int major);
55935d51 279extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
c82f047c 280
64c4757e 281extern int md_get_version(int fd);
e0d19036 282extern int get_linux_version(void);
64c4757e 283extern int parse_uuid(char *str, int uuid[4]);
682c7051
NB
284extern int check_ext2(int fd, char *name);
285extern int check_reiser(int fd, char *name);
286extern int check_raid(int fd, char *name);
64c4757e 287
dd0781e5 288extern int get_mdp_major(void);
8b0dabea 289extern int dev_open(char *dev, int flags);
8d80900b 290extern int is_standard(char *dev, int *nump);
dd0781e5
NB
291
292
e0d19036
NB
293extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
294extern mddev_dev_t conf_get_devs(char *conffile);
295extern char *conf_get_mailaddr(char *conffile);
296extern char *conf_get_program(char *conffile);
297extern char *conf_line(FILE *file);
98c6faba 298extern char *conf_word(FILE *file, int allow_key);
e0d19036
NB
299extern void free_line(char *line);
300extern int match_oneof(char *devices, char *devname);
e0d19036 301extern void uuid_from_super(int uuid[4], mdp_super_t *super);
f277ce36 302extern int same_uuid(int a[4], int b[4], int swapuuid);
4b1ac34b
NB
303/* extern int compare_super(mdp_super_t *first, mdp_super_t *second);*/
304extern unsigned long calc_csum(void *super, int bytes);
265e0f17
NB
305extern int enough(int level, int raid_disks, int layout,
306 char *avail, int avail_disks);
e0d19036 307extern int ask(char *mesg);
8fac0577 308extern unsigned long long get_component_size(int fd);
e0d19036 309
cd29a5c8 310
56eb10c0 311extern char *human_size(long long bytes);
e0d19036
NB
312char *human_size_brief(long long bytes);
313
314extern void put_md_name(char *name);
315extern char *get_md_name(int dev);
316
c913b90e 317extern char DefaultConfFile[];
b5e64645
NB
318
319extern int open_mddev(char *dev, int autof);
320
321
322#define LEVEL_MULTIPATH (-4)
323#define LEVEL_LINEAR (-1)
324#define LEVEL_FAULTY (-5)
325
326
327/* faulty stuff */
328
329#define WriteTransient 0
330#define ReadTransient 1
331#define WritePersistent 2
332#define ReadPersistent 3
333#define WriteAll 4 /* doesn't go to device */
334#define ReadFixable 5
335#define Modes 6
336
337#define ClearErrors 31
338#define ClearFaults 30
339
340#define AllPersist 100 /* internal use only */
341#define NoPersist 101
342
343#define ModeMask 0x1f
344#define ModeShift 5
fe6729fa
NB
345
346
347#ifdef __TINYC__
348#undef minor
349#undef major
350#undef makedev
351#define minor(x) ((x)&0xff)
352#define major(x) (((x)>>8)&0xff)
353#define makedev(M,m) (((M)<<8) | (m))
354#endif
355