Create missing /dev files where needed.
[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 #ifndef __dietlibc__
33 extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
34 #endif
35
36 #include        <sys/types.h>
37 #include        <sys/stat.h>
38 #include        <stdlib.h>
39 #include        <time.h>
40 #include        <sys/time.h>
41 #include        <getopt.h>
42 #include        <fcntl.h>
43 #include        <stdio.h>
44 #include        <errno.h>
45 #include        <string.h>
46 #include        <syslog.h>
47 #ifdef __dietlibc__NONO
48 int strncmp(const char *s1, const char *s2, size_t n) __THROW __pure__;
49 char *strncpy(char *dest, const char *src, size_t n) __THROW;
50 #include    <strings.h>
51 #endif
52
53
54 #include        <linux/kdev_t.h>
55 /*#include      <linux/fs.h> */
56 #include        <sys/mount.h>
57 #include        <asm/types.h>
58 #include        <sys/ioctl.h>
59 #define MD_MAJOR 9
60 #define MdpMinorShift 6
61
62 #ifndef BLKGETSIZE64
63 #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
64 #endif
65
66 #define DEFAULT_BITMAP_CHUNK 4096
67 #define DEFAULT_BITMAP_DELAY 5
68 #define DEFAULT_MAX_WRITE_BEHIND 256
69
70 #include        "md_u.h"
71 #include        "md_p.h"
72 #include        "bitmap.h"
73
74 #include <endian.h>
75 /* #include "asm/byteorder.h" Redhat don't like this so... */
76 #if __BYTE_ORDER == __LITTLE_ENDIAN
77 #  include <linux/byteorder/little_endian.h>
78 #elif __BYTE_ORDER == __BIG_ENDIAN
79 #  include <linux/byteorder/big_endian.h>
80 #elif __BYTE_ORDER == __PDP_ENDIAN
81 #  include <linux/byteorder/pdp_endian.h>
82 #else
83 #  error "unknown endianness."
84 #endif
85
86
87
88 /* general information that might be extracted from a superblock */
89 struct mdinfo {
90         mdu_array_info_t        array;
91         mdu_disk_info_t         disk;
92         __u64                   events;
93         int                     uuid[4];
94         char                    name[33];
95         unsigned long long      data_offset;
96         unsigned long long      component_size;
97         int                     reshape_active;
98         unsigned long long      reshape_progress;
99         int                     new_level, delta_disks, new_layout, new_chunk;
100 };
101
102 #define Name "mdadm"
103
104 enum mode {
105         ASSEMBLE=1,
106         BUILD,
107         CREATE,
108         MANAGE,
109         MISC,
110         MONITOR,
111         GROW,
112 };
113
114 extern char short_options[];
115 extern char short_bitmap_auto_options[];
116 extern struct option long_options[];
117 extern char Version[], Usage[], Help[], OptionHelp[],
118         Help_create[], Help_build[], Help_assemble[], Help_grow[],
119         Help_manage[], Help_misc[], Help_monitor[], Help_config[];
120
121 /* structures read from config file */
122 /* List of mddevice names and identifiers
123  * Identifiers can be:
124  *    uuid=128-hex-uuid
125  *    super-minor=decimal-minor-number-from-superblock
126  *    devices=comma,separated,list,of,device,names,with,wildcards
127  *
128  * If multiple fields are present, the intersection of all matching
129  * devices is considered
130  */
131 #define UnSet (0xfffe)
132 typedef struct mddev_ident_s {
133         char    *devname;
134         
135         int     uuid_set;
136         int     uuid[4];
137         char    name[33];
138
139         unsigned int super_minor;
140
141         char    *devices;       /* comma separated list of device
142                                  * names with wild cards
143                                  */
144         int     level;
145         unsigned int raid_disks;
146         unsigned int spare_disks;
147         struct supertype *st;
148         int     autof;          /* 1 for normal, 2 for partitioned */
149         char    *spare_group;
150         int     bitmap_fd;
151
152         struct mddev_ident_s *next;
153 } *mddev_ident_t;
154
155 /* List of device names - wildcards expanded */
156 typedef struct mddev_dev_s {
157         char *devname;
158         char disposition;       /* 'a' for add, 'r' for remove, 'f' for fail.
159                                  * Not set for names read from .config
160                                  */
161         char writemostly;
162         char re_add;
163         struct mddev_dev_s *next;
164 } *mddev_dev_t;
165
166 typedef struct mapping {
167         char *name;
168         int num;
169 } mapping_t;
170
171
172 struct mdstat_ent {
173         char            *dev;
174         int             devnum;
175         int             active;
176         char            *level;
177         char            *pattern; /* U or up, _ for down */
178         int             percent; /* -1 if no resync */
179         int             resync; /* 1 if resync, 0 if recovery */
180         struct mdstat_ent *next;
181 };
182
183 extern struct mdstat_ent *mdstat_read(int hold, int start);
184 extern void free_mdstat(struct mdstat_ent *ms);
185 extern void mdstat_wait(int seconds);
186
187 /* Data structure for holding info read from sysfs */
188 struct sysdev {
189         char    name[20];
190         int     role;
191         int     major, minor;
192         unsigned long long offset, size;
193         int     state;
194         int     errors;
195         struct sysdev *next;
196 };
197 struct sysarray {
198         char    name[20];
199         struct sysdev *devs;
200         int     chunk;
201         unsigned long long component_size;
202         int     layout;
203         int     level;
204         int     spares;
205 };
206 /* various details can be requested */
207 #define GET_LEVEL       1
208 #define GET_LAYOUT      2
209 #define GET_COMPONENT   4
210 #define GET_CHUNK       8
211
212 #define GET_DEVS        1024 /* gets role, major, minor */
213 #define GET_OFFSET      2048
214 #define GET_SIZE        4096
215 #define GET_STATE       8192
216 #define GET_ERROR       16384
217
218 /* If fd >= 0, get the array it is open on,
219  * else use devnum. >=0 -> major9. <0.....
220  */
221 extern struct sysarray *sysfs_read(int fd, int devnum, unsigned long options);
222 extern int sysfs_set_str(struct sysarray *sra, struct sysdev *dev,
223                          char *name, char *val);
224 extern int sysfs_set_num(struct sysarray *sra, struct sysdev *dev,
225                          char *name, unsigned long long val);
226 extern int sysfs_get_ll(struct sysarray *sra, struct sysdev *dev,
227                         char *name, unsigned long long *val);
228
229
230 extern int save_stripes(int *source, unsigned long long *offsets,
231                         int raid_disks, int chunk_size, int level, int layout,
232                         int nwrites, int *dest,
233                         unsigned long long start, unsigned long long length);
234 extern int restore_stripes(int *dest, unsigned long long *offsets,
235                            int raid_disks, int chunk_size, int level, int layout,
236                            int source, unsigned long long read_offset,
237                            unsigned long long start, unsigned long long length);
238
239 #ifndef Sendmail
240 #define Sendmail "/usr/lib/sendmail -t"
241 #endif
242
243 #define SYSLOG_FACILITY LOG_DAEMON
244
245 extern char *map_num(mapping_t *map, int num);
246 extern int map_name(mapping_t *map, char *name);
247 extern mapping_t r5layout[], pers[], modes[], faultylayout[];
248
249 extern char *map_dev(int major, int minor, int create);
250
251
252 extern struct superswitch {
253         void (*examine_super)(void *sbv);
254         void (*brief_examine_super)(void *sbv);
255         void (*detail_super)(void *sbv);
256         void (*brief_detail_super)(void *sbv);
257         void (*uuid_from_super)(int uuid[4], void *sbv);
258         void (*getinfo_super)(struct mdinfo *info, void *sbv);
259         int (*update_super)(struct mdinfo *info, void *sbv, char *update, char *devname, int verbose);
260         __u64 (*event_super)(void *sbv);
261         int (*init_super)(struct supertype *st, void **sbp, mdu_array_info_t *info, unsigned long long size, char *name);
262         void (*add_to_super)(void *sbv, mdu_disk_info_t *dinfo);
263         int (*store_super)(struct supertype *st, int fd, void *sbv);
264         int (*write_init_super)(struct supertype *st, void *sbv, mdu_disk_info_t *dinfo, char *devname);
265         int (*compare_super)(void **firstp, void *secondv);
266         int (*load_super)(struct supertype *st, int fd, void **sbp, char *devname);
267         struct supertype * (*match_metadata_desc)(char *arg);
268         __u64 (*avail_size)(struct supertype *st, __u64 size);
269         int (*add_internal_bitmap)(struct supertype *st, void *sbv, int chunk, int delay, int write_behind,
270                                    unsigned long long size, int may_change, int major);
271         void (*locate_bitmap)(struct supertype *st, int fd, void *sbv);
272         int (*write_bitmap)(struct supertype *st, int fd, void *sbv);
273         int major;
274         int swapuuid; /* true if uuid is bigending rather than hostendian */
275 } super0, super1, *superlist[];
276
277 struct supertype {
278         struct superswitch *ss;
279         int minor_version;
280         int max_devs;
281 };
282
283 extern struct supertype *super_by_version(int vers, int minor);
284 extern struct supertype *guess_super(int fd);
285
286 #if __GNUC__ < 3
287 struct stat64;
288 #endif
289
290 #ifdef UCLIBC
291   struct FTW {};
292 # define FTW_PHYS 1
293 #else
294 # define  __USE_XOPEN_EXTENDED
295 # include <ftw.h>
296 # ifdef __dietlibc__
297 #  define FTW_PHYS 1
298 # endif
299 #endif
300
301 extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
302
303
304 extern int Manage_ro(char *devname, int fd, int readonly);
305 extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
306 extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
307 extern int Manage_reconfig(char *devname, int fd, int layout);
308 extern int Manage_subdevs(char *devname, int fd,
309                           mddev_dev_t devlist, int verbose);
310 extern int Grow_Add_device(char *devname, int fd, char *newdev);
311 extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
312 extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
313                         long long size,
314                         int level, int layout, int chunksize, int raid_disks);
315 extern int Grow_restart(struct supertype *st, struct mdinfo *info,
316                         int *fdlist, int cnt, char *backup_file);
317
318
319 extern int Assemble(struct supertype *st, char *mddev, int mdfd,
320                     mddev_ident_t ident,
321                     char *conffile,
322                     mddev_dev_t devlist, char *backup_file,
323                     int readonly, int runstop,
324                     char *update,
325                     int verbose, int force);
326
327 extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
328                  int raiddisks,
329                  mddev_dev_t devlist, int assume_clean,
330                  char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int verbose);
331
332
333 extern int Create(struct supertype *st, char *mddev, int mdfd,
334                   int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
335                   char *name,
336                   int subdevs, mddev_dev_t devlist,
337                   int runstop, int verbose, int force, int assume_clean,
338                   char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
339
340 extern int Detail(char *dev, int brief, int test);
341 extern int Query(char *dev);
342 extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
343                    struct supertype *forcest);
344 extern int Monitor(mddev_dev_t devlist,
345                    char *mailaddr, char *alert_cmd,
346                    int period, int daemonise, int scan, int oneshot,
347                    int dosyslog, char *config, int test, char *pidfile);
348
349 extern int Kill(char *dev, int force);
350
351 extern int CreateBitmap(char *filename, int force, char uuid[16],
352                         unsigned long chunksize, unsigned long daemon_sleep,
353                         unsigned long write_behind,
354                         unsigned long long array_size,
355                         int major);
356 extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
357
358 extern int md_get_version(int fd);
359 extern int get_linux_version(void);
360 extern int parse_uuid(char *str, int uuid[4]);
361 extern int check_ext2(int fd, char *name);
362 extern int check_reiser(int fd, char *name);
363 extern int check_raid(int fd, char *name);
364
365 extern int get_mdp_major(void);
366 extern int dev_open(char *dev, int flags);
367 extern int is_standard(char *dev, int *nump);
368
369
370 extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
371 extern mddev_dev_t conf_get_devs(char *conffile);
372 extern char *conf_get_mailaddr(char *conffile);
373 extern char *conf_get_program(char *conffile);
374 extern char *conf_line(FILE *file);
375 extern char *conf_word(FILE *file, int allow_key);
376 extern void free_line(char *line);
377 extern int match_oneof(char *devices, char *devname);
378 extern void uuid_from_super(int uuid[4], mdp_super_t *super);
379 extern int same_uuid(int a[4], int b[4], int swapuuid);
380 /* extern int compare_super(mdp_super_t *first, mdp_super_t *second);*/
381 extern unsigned long calc_csum(void *super, int bytes);
382 extern int enough(int level, int raid_disks, int layout,
383                    char *avail, int avail_disks);
384 extern int ask(char *mesg);
385 extern unsigned long long get_component_size(int fd);
386
387
388 extern char *human_size(long long bytes);
389 char *human_size_brief(long long bytes);
390
391 extern void put_md_name(char *name);
392 extern char *get_md_name(int dev);
393
394 extern char DefaultConfFile[];
395
396 extern int open_mddev(char *dev, int autof);
397
398
399 #define LEVEL_MULTIPATH         (-4)
400 #define LEVEL_LINEAR            (-1)
401 #define LEVEL_FAULTY            (-5)
402
403
404 /* faulty stuff */
405
406 #define WriteTransient  0
407 #define ReadTransient   1
408 #define WritePersistent 2
409 #define ReadPersistent  3
410 #define WriteAll        4 /* doesn't go to device */
411 #define ReadFixable     5
412 #define Modes   6
413
414 #define ClearErrors     31
415 #define ClearFaults     30
416
417 #define AllPersist      100 /* internal use only */
418 #define NoPersist       101
419
420 #define ModeMask        0x1f
421 #define ModeShift       5
422
423
424 #ifdef __TINYC__
425 #undef minor
426 #undef major
427 #undef makedev
428 #define minor(x) ((x)&0xff)
429 #define major(x) (((x)>>8)&0xff)
430 #define makedev(M,m) (((M)<<8) | (m))
431 #endif
432
433 /* for raid5 */
434 #define ALGORITHM_LEFT_ASYMMETRIC       0
435 #define ALGORITHM_RIGHT_ASYMMETRIC      1
436 #define ALGORITHM_LEFT_SYMMETRIC        2
437 #define ALGORITHM_RIGHT_SYMMETRIC       3