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