Release 1.11.0
[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
9a9dab36 68#define Name "mdadm"
682c7051 69
e0d19036
NB
70enum mode {
71 ASSEMBLE=1,
72 BUILD,
73 CREATE,
74 MANAGE,
75 MISC,
76 MONITOR,
dd0781e5 77 GROW,
e0d19036
NB
78};
79
64c4757e
NB
80extern char short_options[];
81extern struct option long_options[];
56eedc1a 82extern char Version[], Usage[], Help[], OptionHelp[],
dd0781e5 83 Help_create[], Help_build[], Help_assemble[], Help_grow[],
e0d19036 84 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e
NB
85
86/* structures read from config file */
52826846
NB
87/* List of mddevice names and identifiers
88 * Identifiers can be:
89 * uuid=128-hex-uuid
90 * super-minor=decimal-minor-number-from-superblock
91 * devices=comma,separated,list,of,device,names,with,wildcards
92 *
93 * If multiple fields are present, the intersection of all matching
94 * devices is considered
95 */
98c6faba 96#define UnSet (0xfffe)
52826846 97typedef struct mddev_ident_s {
dd0781e5 98 char *devname;
52826846 99
dd0781e5
NB
100 int uuid_set;
101 __u32 uuid[4];
52826846 102
98c6faba 103 unsigned int super_minor;
52826846 104
dd0781e5 105 char *devices; /* comma separated list of device
52826846
NB
106 * names with wild cards
107 */
dd0781e5 108 int level;
98c6faba
NB
109 unsigned int raid_disks;
110 unsigned int spare_disks;
dd0781e5
NB
111 int autof; /* 1 for normal, 2 for partitioned */
112 char *spare_group;
113
52826846
NB
114 struct mddev_ident_s *next;
115} *mddev_ident_t;
64c4757e
NB
116
117/* List of device names - wildcards expanded */
118typedef struct mddev_dev_s {
119 char *devname;
cd29a5c8
NB
120 char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
121 * Not set for names read from .config
122 */
64c4757e
NB
123 struct mddev_dev_s *next;
124} *mddev_dev_t;
125
682c7051
NB
126typedef struct mapping {
127 char *name;
128 int num;
129} mapping_t;
130
e0d19036
NB
131
132struct mdstat_ent {
133 char *dev;
134 int devnum;
135 int active;
136 char *level;
137 char *pattern; /* U or up, _ for down */
138 int percent; /* -1 if no resync */
e5329c37 139 int resync; /* 1 if resync, 0 if recovery */
e0d19036
NB
140 struct mdstat_ent *next;
141};
142
dd0781e5 143extern struct mdstat_ent *mdstat_read(int);
e0d19036 144extern void free_mdstat(struct mdstat_ent *ms);
dd0781e5 145extern void mdstat_wait(int seconds);
e0d19036 146
52826846
NB
147#ifndef Sendmail
148#define Sendmail "/usr/lib/sendmail -t"
149#endif
150
682c7051
NB
151extern char *map_num(mapping_t *map, int num);
152extern int map_name(mapping_t *map, char *name);
b5e64645 153extern mapping_t r5layout[], pers[], modes[], faultylayout[];
682c7051 154
82b27616 155extern char *map_dev(int major, int minor);
64c4757e
NB
156
157
158extern int Manage_ro(char *devname, int fd, int readonly);
159extern int Manage_runstop(char *devname, int fd, int runstop);
dd0781e5 160extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
b5e64645 161extern int Manage_reconfig(char *devname, int fd, int layout);
64c4757e 162extern int Manage_subdevs(char *devname, int fd,
cd29a5c8 163 mddev_dev_t devlist);
e5329c37 164extern int Grow_Add_device(char *devname, int fd, char *newdev);
64c4757e
NB
165
166
167extern int Assemble(char *mddev, int mdfd,
52826846
NB
168 mddev_ident_t ident,
169 char *conffile,
cd29a5c8 170 mddev_dev_t devlist,
64c4757e 171 int readonly, int runstop,
5787fa49 172 char *update,
64c4757e
NB
173 int verbose, int force);
174
b5e64645 175extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
64c4757e 176 int raiddisks,
dd0781e5 177 mddev_dev_t devlist, int assume_clean);
64c4757e
NB
178
179
180extern int Create(char *mddev, int mdfd,
aa88f531 181 int chunk, int level, int layout, unsigned long size, int raiddisks, int sparedisks,
cd29a5c8 182 int subdevs, mddev_dev_t devlist,
52826846 183 int runstop, int verbose, int force);
64c4757e 184
feb716e9 185extern int Detail(char *dev, int brief, int test);
e0d19036 186extern int Query(char *dev);
bd526cee 187extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust);
cd29a5c8 188extern int Monitor(mddev_dev_t devlist,
e0d19036 189 char *mailaddr, char *alert_cmd,
aa88f531 190 int period, int daemonise, int scan, int oneshot,
b5e64645 191 char *config, int test, char *pidfile);
64c4757e 192
9a9dab36
NB
193extern int Kill(char *dev, int force);
194
64c4757e 195extern int md_get_version(int fd);
e0d19036 196extern int get_linux_version(void);
64c4757e 197extern int parse_uuid(char *str, int uuid[4]);
682c7051
NB
198extern int check_ext2(int fd, char *name);
199extern int check_reiser(int fd, char *name);
200extern int check_raid(int fd, char *name);
64c4757e 201
dd0781e5 202extern int get_mdp_major(void);
8d80900b 203extern int is_standard(char *dev, int *nump);
dd0781e5
NB
204
205
e0d19036
NB
206extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
207extern mddev_dev_t conf_get_devs(char *conffile);
208extern char *conf_get_mailaddr(char *conffile);
209extern char *conf_get_program(char *conffile);
210extern char *conf_line(FILE *file);
98c6faba 211extern char *conf_word(FILE *file, int allow_key);
e0d19036
NB
212extern void free_line(char *line);
213extern int match_oneof(char *devices, char *devname);
214extern int load_super(int fd, mdp_super_t *super);
215extern void uuid_from_super(int uuid[4], mdp_super_t *super);
216extern int same_uuid(int a[4], int b[4]);
217extern int compare_super(mdp_super_t *first, mdp_super_t *second);
98c6faba 218extern unsigned long calc_sb_csum(mdp_super_t *super);
e0d19036
NB
219extern int store_super(int fd, mdp_super_t *super);
220extern int enough(int level, int raid_disks, int avail_disks);
221extern int ask(char *mesg);
222
cd29a5c8 223
56eb10c0 224extern char *human_size(long long bytes);
e0d19036
NB
225char *human_size_brief(long long bytes);
226
227extern void put_md_name(char *name);
228extern char *get_md_name(int dev);
229
c913b90e 230extern char DefaultConfFile[];
b5e64645
NB
231
232extern int open_mddev(char *dev, int autof);
233
234
235#define LEVEL_MULTIPATH (-4)
236#define LEVEL_LINEAR (-1)
237#define LEVEL_FAULTY (-5)
238
239
240/* faulty stuff */
241
242#define WriteTransient 0
243#define ReadTransient 1
244#define WritePersistent 2
245#define ReadPersistent 3
246#define WriteAll 4 /* doesn't go to device */
247#define ReadFixable 5
248#define Modes 6
249
250#define ClearErrors 31
251#define ClearFaults 30
252
253#define AllPersist 100 /* internal use only */
254#define NoPersist 101
255
256#define ModeMask 0x1f
257#define ModeShift 5