Add a 'super-switch' so that different format superblocks can be used.
[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>
40#include <getopt.h>
41#include <fcntl.h>
42#include <stdio.h>
43#include <errno.h>
44#include <string.h>
98c6faba
NB
45#ifdef __dietlibc__NONO
46int strncmp(const char *s1, const char *s2, size_t n) __THROW __pure__;
47char *strncpy(char *dest, const char *src, size_t n) __THROW;
48#include <strings.h>
49#endif
50
64c4757e
NB
51
52#include <linux/kdev_t.h>
e0d19036
NB
53/*#include <linux/fs.h> */
54#include <sys/mount.h>
55#include <asm/types.h>
64c4757e
NB
56#include <sys/ioctl.h>
57#define MD_MAJOR 9
dd0781e5 58#define MdpMinorShift 6
64c4757e 59
e0d19036 60#ifndef BLKGETSIZE64
98c6faba 61#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
e0d19036 62#endif
56eb10c0 63
64c4757e
NB
64
65#include "md_u.h"
e0d19036 66#include "md_p.h"
64c4757e 67
4b1ac34b
NB
68/* general information that might be extracted from a superblock */
69struct mdinfo {
70 mdu_array_info_t array;
71 mdu_disk_info_t disk;
72 __u64 events;
73 unsigned int uuid[4];
74};
75
9a9dab36 76#define Name "mdadm"
682c7051 77
e0d19036
NB
78enum mode {
79 ASSEMBLE=1,
80 BUILD,
81 CREATE,
82 MANAGE,
83 MISC,
84 MONITOR,
dd0781e5 85 GROW,
e0d19036
NB
86};
87
64c4757e
NB
88extern char short_options[];
89extern struct option long_options[];
56eedc1a 90extern char Version[], Usage[], Help[], OptionHelp[],
dd0781e5 91 Help_create[], Help_build[], Help_assemble[], Help_grow[],
e0d19036 92 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e
NB
93
94/* structures read from config file */
52826846
NB
95/* List of mddevice names and identifiers
96 * Identifiers can be:
97 * uuid=128-hex-uuid
98 * super-minor=decimal-minor-number-from-superblock
99 * devices=comma,separated,list,of,device,names,with,wildcards
100 *
101 * If multiple fields are present, the intersection of all matching
102 * devices is considered
103 */
98c6faba 104#define UnSet (0xfffe)
52826846 105typedef struct mddev_ident_s {
dd0781e5 106 char *devname;
52826846 107
dd0781e5
NB
108 int uuid_set;
109 __u32 uuid[4];
52826846 110
98c6faba 111 unsigned int super_minor;
52826846 112
dd0781e5 113 char *devices; /* comma separated list of device
52826846
NB
114 * names with wild cards
115 */
dd0781e5 116 int level;
98c6faba
NB
117 unsigned int raid_disks;
118 unsigned int spare_disks;
f9ce90ba 119 struct superswitch *ss;
dd0781e5
NB
120 int autof; /* 1 for normal, 2 for partitioned */
121 char *spare_group;
122
52826846
NB
123 struct mddev_ident_s *next;
124} *mddev_ident_t;
64c4757e
NB
125
126/* List of device names - wildcards expanded */
127typedef struct mddev_dev_s {
128 char *devname;
cd29a5c8
NB
129 char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
130 * Not set for names read from .config
131 */
64c4757e
NB
132 struct mddev_dev_s *next;
133} *mddev_dev_t;
134
682c7051
NB
135typedef struct mapping {
136 char *name;
137 int num;
138} mapping_t;
139
e0d19036
NB
140
141struct mdstat_ent {
142 char *dev;
143 int devnum;
144 int active;
145 char *level;
146 char *pattern; /* U or up, _ for down */
147 int percent; /* -1 if no resync */
e5329c37 148 int resync; /* 1 if resync, 0 if recovery */
e0d19036
NB
149 struct mdstat_ent *next;
150};
151
dd0781e5 152extern struct mdstat_ent *mdstat_read(int);
e0d19036 153extern void free_mdstat(struct mdstat_ent *ms);
dd0781e5 154extern void mdstat_wait(int seconds);
e0d19036 155
52826846
NB
156#ifndef Sendmail
157#define Sendmail "/usr/lib/sendmail -t"
158#endif
159
682c7051
NB
160extern char *map_num(mapping_t *map, int num);
161extern int map_name(mapping_t *map, char *name);
b5e64645 162extern mapping_t r5layout[], pers[], modes[], faultylayout[];
682c7051 163
82b27616 164extern char *map_dev(int major, int minor);
64c4757e
NB
165
166
f9ce90ba
NB
167extern struct superswitch {
168 void (*examine_super)(void *sbv);
169 void (*brief_examine_super)(void *sbv);
170 void (*detail_super)(void *sbv);
171 void (*brief_detail_super)(void *sbv);
172 void (*uuid_from_super)(int uuid[4], void *sbv);
173 void (*getinfo_super)(struct mdinfo *info, void *sbv);
174 int (*update_super)(struct mdinfo *info, void *sbv, char *update, char *devname, int verbose);
175 __u64 (*event_super)(void *sbv);
176 void (*init_super)(void **sbp, mdu_array_info_t *info);
177 void (*add_to_super)(void *sbv, mdu_disk_info_t *dinfo);
178 int (*store_super)(int fd, void *sbv);
179 int (*write_init_super)(void *sbv, mdu_disk_info_t *dinfo, char *devname);
180 int (*compare_super)(void **firstp, void *secondv);
181 int (*load_super)(int fd, void **sbp, char *devname);
182 int (*match_metadata_desc)(char *arg);
183} super0, *superlist[];
184
185extern struct superswitch *super_by_version(int vers);
186extern struct superswitch *guess_super(int fd, char *dev);
187
188
64c4757e
NB
189extern int Manage_ro(char *devname, int fd, int readonly);
190extern int Manage_runstop(char *devname, int fd, int runstop);
dd0781e5 191extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
b5e64645 192extern int Manage_reconfig(char *devname, int fd, int layout);
64c4757e 193extern int Manage_subdevs(char *devname, int fd,
cd29a5c8 194 mddev_dev_t devlist);
e5329c37 195extern int Grow_Add_device(char *devname, int fd, char *newdev);
64c4757e
NB
196
197
f9ce90ba 198extern int Assemble(struct superswitch *ss, char *mddev, int mdfd,
52826846
NB
199 mddev_ident_t ident,
200 char *conffile,
cd29a5c8 201 mddev_dev_t devlist,
64c4757e 202 int readonly, int runstop,
5787fa49 203 char *update,
64c4757e
NB
204 int verbose, int force);
205
b5e64645 206extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
64c4757e 207 int raiddisks,
dd0781e5 208 mddev_dev_t devlist, int assume_clean);
64c4757e
NB
209
210
f9ce90ba 211extern int Create(struct superswitch *ss, char *mddev, int mdfd,
aa88f531 212 int chunk, int level, int layout, unsigned long size, int raiddisks, int sparedisks,
cd29a5c8 213 int subdevs, mddev_dev_t devlist,
52826846 214 int runstop, int verbose, int force);
64c4757e 215
feb716e9 216extern int Detail(char *dev, int brief, int test);
e0d19036 217extern int Query(char *dev);
bd526cee 218extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust);
cd29a5c8 219extern int Monitor(mddev_dev_t devlist,
e0d19036 220 char *mailaddr, char *alert_cmd,
aa88f531 221 int period, int daemonise, int scan, int oneshot,
b5e64645 222 char *config, int test, char *pidfile);
64c4757e 223
9a9dab36
NB
224extern int Kill(char *dev, int force);
225
64c4757e 226extern int md_get_version(int fd);
e0d19036 227extern int get_linux_version(void);
64c4757e 228extern int parse_uuid(char *str, int uuid[4]);
682c7051
NB
229extern int check_ext2(int fd, char *name);
230extern int check_reiser(int fd, char *name);
231extern int check_raid(int fd, char *name);
64c4757e 232
dd0781e5 233extern int get_mdp_major(void);
8d80900b 234extern int is_standard(char *dev, int *nump);
dd0781e5
NB
235
236
e0d19036
NB
237extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
238extern mddev_dev_t conf_get_devs(char *conffile);
239extern char *conf_get_mailaddr(char *conffile);
240extern char *conf_get_program(char *conffile);
241extern char *conf_line(FILE *file);
98c6faba 242extern char *conf_word(FILE *file, int allow_key);
e0d19036
NB
243extern void free_line(char *line);
244extern int match_oneof(char *devices, char *devname);
e0d19036
NB
245extern void uuid_from_super(int uuid[4], mdp_super_t *super);
246extern int same_uuid(int a[4], int b[4]);
4b1ac34b
NB
247/* extern int compare_super(mdp_super_t *first, mdp_super_t *second);*/
248extern unsigned long calc_csum(void *super, int bytes);
e0d19036
NB
249extern int store_super(int fd, mdp_super_t *super);
250extern int enough(int level, int raid_disks, int avail_disks);
251extern int ask(char *mesg);
252
cd29a5c8 253
56eb10c0 254extern char *human_size(long long bytes);
e0d19036
NB
255char *human_size_brief(long long bytes);
256
257extern void put_md_name(char *name);
258extern char *get_md_name(int dev);
259
c913b90e 260extern char DefaultConfFile[];
b5e64645
NB
261
262extern int open_mddev(char *dev, int autof);
263
264
265#define LEVEL_MULTIPATH (-4)
266#define LEVEL_LINEAR (-1)
267#define LEVEL_FAULTY (-5)
268
269
270/* faulty stuff */
271
272#define WriteTransient 0
273#define ReadTransient 1
274#define WritePersistent 2
275#define ReadPersistent 3
276#define WriteAll 4 /* doesn't go to device */
277#define ReadFixable 5
278#define Modes 6
279
280#define ClearErrors 31
281#define ClearFaults 30
282
283#define AllPersist 100 /* internal use only */
284#define NoPersist 101
285
286#define ModeMask 0x1f
287#define ModeShift 5