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