mdadm-1.0.1
[thirdparty/mdadm.git] / mdadm.h
1 /*
2  * mdadm - manage Linux "md" devices aka RAID arrays.
3  *
4  * Copyright (C) 2001-2002 Neil Brown <neilb@cse.unsw.edu.au>
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>
32 extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
33
34 #include        <sys/types.h>
35 #include        <sys/stat.h>
36 #include        <stdlib.h>
37 #include        <time.h>
38 #include        <getopt.h>
39 #include        <fcntl.h>
40 #include        <stdio.h>
41 #include        <errno.h>
42 #include        <string.h>
43
44 #include        <linux/kdev_t.h>
45 /*#include      <linux/fs.h> */
46 #include        <sys/mount.h>
47 #include        <asm/types.h>
48 #include        <sys/ioctl.h>
49 #define MD_MAJOR 9
50
51 #ifndef BLKGETSIZE64
52 #define BLKGETSIZE64 _IOR(0x12,114,sizeof(__u64)) /* return device size in bytes (u64 *arg) */
53 #endif
54
55
56 #include        "md_u.h"
57 #include        "md_p.h"
58
59 #define Name "mdadm"
60
61 enum mode {
62         ASSEMBLE=1,
63         BUILD,
64         CREATE,
65         MANAGE,
66         MISC,
67         MONITOR,
68 };
69
70 extern char short_options[];
71 extern struct option long_options[];
72 extern char Version[], Usage[], Help[],
73         Help_create[], Help_build[], Help_assemble[],
74         Help_manage[], Help_misc[], Help_monitor[], Help_config[];
75
76 /* structures read from config file */
77 /* List of mddevice names and identifiers
78  * Identifiers can be:
79  *    uuid=128-hex-uuid
80  *    super-minor=decimal-minor-number-from-superblock
81  *    devices=comma,separated,list,of,device,names,with,wildcards
82  *
83  * If multiple fields are present, the intersection of all matching
84  * devices is considered
85  */
86 typedef struct mddev_ident_s {
87         char *devname;
88         
89         int uuid_set;
90         __u32 uuid[4];
91
92         int super_minor;        /* -1 if not set */
93
94         char *devices;          /* comma separated list of device
95                                  * names with wild cards
96                                  */
97         int level;              /* -10 if not set */
98         int raid_disks;         /* -1 if not set */
99         char *spare_group;
100         struct mddev_ident_s *next;
101 } *mddev_ident_t;
102
103 /* List of device names - wildcards expanded */
104 typedef struct mddev_dev_s {
105         char *devname;
106         char disposition;       /* 'a' for add, 'r' for remove, 'f' for fail.
107                                  * Not set for names read from .config
108                                  */
109         struct mddev_dev_s *next;
110 } *mddev_dev_t;
111
112 typedef struct mapping {
113         char *name;
114         int num;
115 } mapping_t;
116
117
118 struct mdstat_ent {
119         char            *dev;
120         int             devnum;
121         int             active;
122         char            *level;
123         char            *pattern; /* U or up, _ for down */
124         int             percent; /* -1 if no resync */
125         struct mdstat_ent *next;
126 };
127
128 extern struct mdstat_ent *mdstat_read(void);
129 extern void free_mdstat(struct mdstat_ent *ms);
130
131 #ifndef Sendmail
132 #define Sendmail "/usr/lib/sendmail -t"
133 #endif
134
135 extern char *map_num(mapping_t *map, int num);
136 extern int map_name(mapping_t *map, char *name);
137 extern mapping_t r5layout[], pers[], modes[];
138
139 extern char *map_dev(int major, int minor);
140
141
142 extern int Manage_ro(char *devname, int fd, int readonly);
143 extern int Manage_runstop(char *devname, int fd, int runstop);
144 extern int Manage_subdevs(char *devname, int fd,
145                           mddev_dev_t devlist);
146
147
148 extern int Assemble(char *mddev, int mdfd,
149                     mddev_ident_t ident,
150                     char *conffile,
151                     mddev_dev_t devlist,
152                     int readonly, int runstop,
153                     int verbose, int force);
154
155 extern int Build(char *mddev, int mdfd, int chunk, int level,
156                  int raiddisks,
157                  mddev_dev_t devlist);
158
159
160 extern int Create(char *mddev, int mdfd,
161                   int chunk, int level, int layout, int size, int raiddisks, int sparedisks,
162                   int subdevs, mddev_dev_t devlist,
163                   int runstop, int verbose, int force);
164
165 extern int Detail(char *dev, int brief);
166 extern int Query(char *dev);
167 extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust);
168 extern int Monitor(mddev_dev_t devlist,
169                    char *mailaddr, char *alert_cmd,
170                    int period, int scan,
171                    char *config);
172
173 extern int Kill(char *dev, int force);
174
175 extern int md_get_version(int fd);
176 extern int get_linux_version(void);
177 extern int parse_uuid(char *str, int uuid[4]);
178 extern int check_ext2(int fd, char *name);
179 extern int check_reiser(int fd, char *name);
180 extern int check_raid(int fd, char *name);
181
182 extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
183 extern mddev_dev_t conf_get_devs(char *conffile);
184 extern char *conf_get_mailaddr(char *conffile);
185 extern char *conf_get_program(char *conffile);
186 extern char *conf_line(FILE *file);
187 extern void free_line(char *line);
188 extern int match_oneof(char *devices, char *devname);
189 extern int load_super(int fd, mdp_super_t *super);
190 extern void uuid_from_super(int uuid[4], mdp_super_t *super);
191 extern int same_uuid(int a[4], int b[4]);
192 extern int compare_super(mdp_super_t *first, mdp_super_t *second);
193 extern int calc_sb_csum(mdp_super_t *super);
194 extern int store_super(int fd, mdp_super_t *super);
195 extern int enough(int level, int raid_disks, int avail_disks);
196 extern int ask(char *mesg);
197
198
199 extern char *human_size(long long bytes);
200 char *human_size_brief(long long bytes);
201
202 extern void put_md_name(char *name);
203 extern char *get_md_name(int dev);
204
205 extern char DefaultConfFile[];