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