Add crc32 files.
[thirdparty/mdadm.git] / mdadm.h
1 /*
2  * mdadm - manage Linux "md" devices aka RAID arrays.
3  *
4  * Copyright (C) 2001-2006 Neil Brown <neilb@suse.de>
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 _GNU_SOURCE
31 #define _FILE_OFFSET_BITS 64
32 #include        <unistd.h>
33 #if !defined(__dietlibc__) && !defined(__KLIBC__)
34 extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
35 #else
36 # if defined(__NO_STAT64) || __WORDSIZE != 32
37 # define lseek64 lseek
38 # endif
39 #endif
40
41 #include        <sys/types.h>
42 #include        <sys/stat.h>
43 #include        <stdlib.h>
44 #include        <time.h>
45 #include        <sys/time.h>
46 #include        <getopt.h>
47 #include        <fcntl.h>
48 #include        <stdio.h>
49 #include        <errno.h>
50 #include        <string.h>
51 #include        <syslog.h>
52 #ifdef __dietlibc__
53 #include        <strings.h>
54 /* dietlibc has deprecated random and srandom!! */
55 #define random rand
56 #define srandom srand
57 #endif
58
59
60 #include        <linux/kdev_t.h>
61 /*#include      <linux/fs.h> */
62 #include        <sys/mount.h>
63 #include        <asm/types.h>
64 #include        <sys/ioctl.h>
65 #define MD_MAJOR 9
66 #define MdpMinorShift 6
67
68 #ifndef BLKGETSIZE64
69 #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
70 #endif
71
72 #define DEFAULT_BITMAP_CHUNK 4096
73 #define DEFAULT_BITMAP_DELAY 5
74 #define DEFAULT_MAX_WRITE_BEHIND 256
75
76 #include        "md_u.h"
77 #include        "md_p.h"
78 #include        "bitmap.h"
79
80 #include <endian.h>
81 /* Redhat don't like to #include <asm/byteorder.h>, and
82  * some time include <linux/byteorder/xxx_endian.h> isn't enough,
83  * and there is no standard conversion function so... */
84 /* And dietlibc doesn't think byteswap is ok, so.. */
85 /*  #include <byteswap.h> */
86 #define bswap_16(x) (((x) & 0x00ffU) << 8 | \
87                      ((x) & 0xff00U) >> 8)
88 #define bswap_32(x) (((x) & 0x000000ffU) << 24 | \
89                      ((x) & 0xff000000U) >> 24 | \
90                      ((x) & 0x0000ff00U) << 8  | \
91                      ((x) & 0x00ff0000U) >> 8)
92 #define bswap_64(x) (((x) & 0x00000000000000ffULL) << 56 | \
93                      ((x) & 0xff00000000000000ULL) >> 56 | \
94                      ((x) & 0x000000000000ff00ULL) << 40 | \
95                      ((x) & 0x00ff000000000000ULL) >> 40 | \
96                      ((x) & 0x0000000000ff0000ULL) << 24 | \
97                      ((x) & 0x0000ff0000000000ULL) >> 24 | \
98                      ((x) & 0x00000000ff000000ULL) << 8 | \
99                      ((x) & 0x000000ff00000000ULL) >> 8)
100
101 #if !defined(__KLIBC__)
102 #if BYTE_ORDER == LITTLE_ENDIAN
103 #define __cpu_to_le16(_x) (_x)
104 #define __cpu_to_le32(_x) (_x)
105 #define __cpu_to_le64(_x) (_x)
106 #define __le16_to_cpu(_x) (_x)
107 #define __le32_to_cpu(_x) (_x)
108 #define __le64_to_cpu(_x) (_x)
109
110 #define __cpu_to_be16(_x) bswap_16(_x)
111 #define __cpu_to_be32(_x) bswap_32(_x)
112 #define __cpu_to_be64(_x) bswap_64(_x)
113 #define __be16_to_cpu(_x) bswap_16(_x)
114 #define __be32_to_cpu(_x) bswap_32(_x)
115 #define __be64_to_cpu(_x) bswap_64(_x)
116 #elif BYTE_ORDER == BIG_ENDIAN
117 #define __cpu_to_le16(_x) bswap_16(_x)
118 #define __cpu_to_le32(_x) bswap_32(_x)
119 #define __cpu_to_le64(_x) bswap_64(_x)
120 #define __le16_to_cpu(_x) bswap_16(_x)
121 #define __le32_to_cpu(_x) bswap_32(_x)
122 #define __le64_to_cpu(_x) bswap_64(_x)
123
124 #define __cpu_to_be16(_x) (_x)
125 #define __cpu_to_be32(_x) (_x)
126 #define __cpu_to_be64(_x) (_x)
127 #define __be16_to_cpu(_x) (_x)
128 #define __be32_to_cpu(_x) (_x)
129 #define __be64_to_cpu(_x) (_x)
130 #else
131 #  error "unknown endianness."
132 #endif
133 #endif /* __KLIBC__ */
134
135
136
137 /* general information that might be extracted from a superblock */
138 struct mdinfo {
139         mdu_array_info_t        array;
140         mdu_disk_info_t         disk;
141         __u64                   events;
142         int                     uuid[4];
143         char                    name[33];
144         unsigned long long      data_offset;
145         unsigned long long      component_size;
146         int                     reshape_active;
147         unsigned long long      reshape_progress;
148         int                     new_level, delta_disks, new_layout, new_chunk;
149         int                     errors;
150         int                     cache_size; /* size of raid456 stripe cache*/
151         int                     mismatch_cnt;
152         char                    text_version[50];
153
154         char            sys_name[20];
155         struct mdinfo *devs;
156         struct mdinfo *next;
157 };
158
159 struct createinfo {
160         int     uid;
161         int     gid;
162         int     autof;
163         int     mode;
164         int     symlinks;
165         struct supertype *supertype;
166 };
167
168 #define Name "mdadm"
169
170 enum mode {
171         ASSEMBLE=1,
172         BUILD,
173         CREATE,
174         MANAGE,
175         MISC,
176         MONITOR,
177         GROW,
178         INCREMENTAL,
179         AUTODETECT,
180 };
181
182 extern char short_options[];
183 extern char short_bitmap_options[];
184 extern char short_bitmap_auto_options[];
185 extern struct option long_options[];
186 extern char Version[], Usage[], Help[], OptionHelp[],
187         Help_create[], Help_build[], Help_assemble[], Help_grow[],
188         Help_incr[],
189         Help_manage[], Help_misc[], Help_monitor[], Help_config[];
190
191 /* for option that don't have short equivilents, we assign arbitrary
192  * small numbers.  '1' means an undecorated option, so we start at '2'.
193  */
194 enum special_options {
195         AssumeClean = 2,
196         BitmapChunk,
197         WriteBehind,
198         ReAdd,
199         NoDegraded,
200         Sparc22,
201         BackupFile,
202         HomeHost,
203         AutoHomeHost,
204         Symlinks,
205         AutoDetect,
206 };
207
208 /* structures read from config file */
209 /* List of mddevice names and identifiers
210  * Identifiers can be:
211  *    uuid=128-hex-uuid
212  *    super-minor=decimal-minor-number-from-superblock
213  *    devices=comma,separated,list,of,device,names,with,wildcards
214  *
215  * If multiple fields are present, the intersection of all matching
216  * devices is considered
217  */
218 #define UnSet (0xfffe)
219 typedef struct mddev_ident_s {
220         char    *devname;
221
222         int     uuid_set;
223         int     uuid[4];
224         char    name[33];
225
226         unsigned int super_minor;
227
228         char    *devices;       /* comma separated list of device
229                                  * names with wild cards
230                                  */
231         int     level;
232         unsigned int raid_disks;
233         unsigned int spare_disks;
234         struct supertype *st;
235         int     autof;          /* 1 for normal, 2 for partitioned */
236         char    *spare_group;
237         char    *bitmap_file;
238         int     bitmap_fd;
239
240         struct mddev_ident_s *next;
241 } *mddev_ident_t;
242
243 /* List of device names - wildcards expanded */
244 typedef struct mddev_dev_s {
245         char *devname;
246         char disposition;       /* 'a' for add, 'r' for remove, 'f' for fail.
247                                  * Not set for names read from .config
248                                  */
249         char writemostly;
250         char re_add;
251         char used;              /* set when used */
252         struct mddev_dev_s *next;
253 } *mddev_dev_t;
254
255 typedef struct mapping {
256         char *name;
257         int num;
258 } mapping_t;
259
260
261 struct mdstat_ent {
262         char            *dev;
263         int             devnum;
264         int             active;
265         char            *level;
266         char            *pattern; /* U or up, _ for down */
267         int             percent; /* -1 if no resync */
268         int             resync; /* 1 if resync, 0 if recovery */
269         struct mdstat_ent *next;
270 };
271
272 extern struct mdstat_ent *mdstat_read(int hold, int start);
273 extern void free_mdstat(struct mdstat_ent *ms);
274 extern void mdstat_wait(int seconds);
275 extern int mddev_busy(int devnum);
276
277 struct map_ent {
278         struct map_ent *next;
279         int     devnum;
280         int     major,minor;
281         int     uuid[4];
282         char    *path;
283 };
284 extern int map_update(struct map_ent **mpp, int devnum, int major, int minor,
285                       int uuid[4], char *path);
286 extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
287 extern void map_read(struct map_ent **melp);
288 extern int map_write(struct map_ent *mel);
289 extern void map_delete(struct map_ent **mapp, int devnum);
290 extern void map_free(struct map_ent *map);
291 extern void map_add(struct map_ent **melp,
292                     int devnum, int major, int minor, int uuid[4], char *path);
293
294 /* various details can be requested */
295 #define GET_LEVEL       1
296 #define GET_LAYOUT      2
297 #define GET_COMPONENT   4
298 #define GET_CHUNK       8
299 #define GET_CACHE       16
300 #define GET_MISMATCH    32
301 #define GET_VERSION     64
302
303 #define GET_DEVS        1024 /* gets role, major, minor */
304 #define GET_OFFSET      2048
305 #define GET_SIZE        4096
306 #define GET_STATE       8192
307 #define GET_ERROR       16384
308
309 /* If fd >= 0, get the array it is open on,
310  * else use devnum. >=0 -> major9. <0.....
311  */
312 extern void sysfs_free(struct mdinfo *sra);
313 extern struct mdinfo *sysfs_read(int fd, int devnum, unsigned long options);
314 extern int sysfs_set_str(struct mdinfo *sra, struct mdinfo *dev,
315                          char *name, char *val);
316 extern int sysfs_set_num(struct mdinfo *sra, struct mdinfo *dev,
317                          char *name, unsigned long long val);
318 extern int sysfs_get_ll(struct mdinfo *sra, struct mdinfo *dev,
319                         char *name, unsigned long long *val);
320
321
322 extern int save_stripes(int *source, unsigned long long *offsets,
323                         int raid_disks, int chunk_size, int level, int layout,
324                         int nwrites, int *dest,
325                         unsigned long long start, unsigned long long length);
326 extern int restore_stripes(int *dest, unsigned long long *offsets,
327                            int raid_disks, int chunk_size, int level, int layout,
328                            int source, unsigned long long read_offset,
329                            unsigned long long start, unsigned long long length);
330
331 #ifndef Sendmail
332 #define Sendmail "/usr/lib/sendmail -t"
333 #endif
334
335 #define SYSLOG_FACILITY LOG_DAEMON
336
337 extern char *map_num(mapping_t *map, int num);
338 extern int map_name(mapping_t *map, char *name);
339 extern mapping_t r5layout[], pers[], modes[], faultylayout[];
340
341 extern char *map_dev(int major, int minor, int create);
342
343
344 extern struct superswitch {
345         void (*examine_super)(struct supertype *st, char *homehost);
346         void (*brief_examine_super)(struct supertype *st);
347         void (*export_examine_super)(struct supertype *st);
348         void (*detail_super)(struct supertype *st, char *homehost);
349         void (*brief_detail_super)(struct supertype *st);
350         void (*export_detail_super)(struct supertype *st);
351         void (*uuid_from_super)(struct supertype *st, int uuid[4]);
352         void (*getinfo_super)(struct supertype *st, struct mdinfo *info);
353         int (*match_home)(struct supertype *st, char *homehost);
354         int (*update_super)(struct supertype *st, struct mdinfo *info,
355                             char *update,
356                             char *devname, int verbose,
357                             int uuid_set, char *homehost);
358         int (*init_super)(struct supertype *st, mdu_array_info_t *info,
359                           unsigned long long size, char *name,
360                           char *homehost, int *uuid);
361         void (*add_to_super)(struct supertype *st, mdu_disk_info_t *dinfo);
362         int (*store_super)(struct supertype *st, int fd);
363         int (*write_init_super)(struct supertype *st, mdu_disk_info_t *dinfo,
364                                 char *devname);
365         int (*compare_super)(struct supertype *st, struct supertype *tst);
366         int (*load_super)(struct supertype *st, int fd, char *devname);
367         struct supertype * (*match_metadata_desc)(char *arg);
368         __u64 (*avail_size)(struct supertype *st, __u64 size);
369         int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
370                                    int delay, int write_behind,
371                                    unsigned long long size, int may_change, int major);
372         void (*locate_bitmap)(struct supertype *st, int fd);
373         int (*write_bitmap)(struct supertype *st, int fd);
374         void (*free_super)(struct supertype *st);
375         int (*validate_geometry)(struct supertype *st, int level, int layout,
376                                  int raiddisks,
377                                  int chunk, unsigned long long size,
378                                  char *subdev, unsigned long long *freesize);
379         int major;
380         int swapuuid; /* true if uuid is bigending rather than hostendian */
381 } super0, super1, *superlist[];
382
383 struct supertype {
384         struct superswitch *ss;
385         int minor_version;
386         int max_devs;
387         void *sb;
388 };
389
390 extern struct supertype *super_by_fd(int fd);
391 extern struct supertype *guess_super(int fd);
392 extern struct supertype *dup_super(struct supertype *st);
393 extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
394 extern void get_one_disk(int mdfd, mdu_array_info_t *ainf,
395                          mdu_disk_info_t *disk);
396
397 #if __GNUC__ < 3
398 struct stat64;
399 #endif
400
401 #define HAVE_NFTW  we assume
402 #define HAVE_FTW
403
404 #ifdef UCLIBC
405 # include <features.h>
406 # ifndef  __UCLIBC_HAS_FTW__
407 #  undef HAVE_FTW
408 #  undef HAVE_NFTW
409 # endif
410 #endif
411
412 #ifdef __dietlibc__
413 # undef HAVE_NFTW
414 #endif
415
416 #if defined(__KLIBC__)
417 # undef HAVE_NFTW
418 # undef HAVE_FTW
419 #endif
420
421 #ifndef HAVE_NFTW
422 # define FTW_PHYS 1
423 # ifndef HAVE_FTW
424   struct FTW {};
425 # endif
426 #endif
427
428 #ifdef HAVE_FTW
429 # include <ftw.h>
430 #endif
431
432 extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
433
434
435 extern int Manage_ro(char *devname, int fd, int readonly);
436 extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
437 extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
438 extern int Manage_reconfig(char *devname, int fd, int layout);
439 extern int Manage_subdevs(char *devname, int fd,
440                           mddev_dev_t devlist, int verbose);
441 extern int autodetect(void);
442 extern int Grow_Add_device(char *devname, int fd, char *newdev);
443 extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
444 extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
445                         long long size,
446                         int level, int layout, int chunksize, int raid_disks);
447 extern int Grow_restart(struct supertype *st, struct mdinfo *info,
448                         int *fdlist, int cnt, char *backup_file);
449
450
451 extern int Assemble(struct supertype *st, char *mddev, int mdfd,
452                     mddev_ident_t ident,
453                     mddev_dev_t devlist, char *backup_file,
454                     int readonly, int runstop,
455                     char *update, char *homehost,
456                     int verbose, int force);
457
458 extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
459                  int raiddisks,
460                  mddev_dev_t devlist, int assume_clean,
461                  char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int verbose);
462
463
464 extern int Create(struct supertype *st, char *mddev, int mdfd,
465                   int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
466                   char *name, char *homehost, int *uuid,
467                   int subdevs, mddev_dev_t devlist,
468                   int runstop, int verbose, int force, int assume_clean,
469                   char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
470
471 extern int Detail(char *dev, int brief, int export, int test, char *homehost);
472 extern int Query(char *dev);
473 extern int Examine(mddev_dev_t devlist, int brief, int export, int scan,
474                    int SparcAdjust, struct supertype *forcest, char *homehost);
475 extern int Monitor(mddev_dev_t devlist,
476                    char *mailaddr, char *alert_cmd,
477                    int period, int daemonise, int scan, int oneshot,
478                    int dosyslog, int test, char *pidfile);
479
480 extern int Kill(char *dev, int force, int quiet);
481 extern int Wait(char *dev);
482
483 extern int Incremental(char *devname, int verbose, int runstop,
484                        struct supertype *st, char *homehost, int autof);
485 extern void RebuildMap(void);
486 extern int IncrementalScan(int verbose);
487
488 extern int CreateBitmap(char *filename, int force, char uuid[16],
489                         unsigned long chunksize, unsigned long daemon_sleep,
490                         unsigned long write_behind,
491                         unsigned long long array_size,
492                         int major);
493 extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
494 extern int bitmap_update_uuid(int fd, int *uuid, int swap);
495
496 extern int md_get_version(int fd);
497 extern int get_linux_version(void);
498 extern int parse_uuid(char *str, int uuid[4]);
499 extern int check_ext2(int fd, char *name);
500 extern int check_reiser(int fd, char *name);
501 extern int check_raid(int fd, char *name);
502
503 extern int get_mdp_major(void);
504 extern int dev_open(char *dev, int flags);
505 extern int is_standard(char *dev, int *nump);
506
507 extern int parse_auto(char *str, char *msg, int config);
508 extern mddev_ident_t conf_get_ident(char *dev);
509 extern mddev_dev_t conf_get_devs(void);
510 extern int conf_test_dev(char *devname);
511 extern struct createinfo *conf_get_create_info(void);
512 extern void set_conffile(char *file);
513 extern char *conf_get_mailaddr(void);
514 extern char *conf_get_mailfrom(void);
515 extern char *conf_get_program(void);
516 extern char *conf_get_homehost(void);
517 extern char *conf_line(FILE *file);
518 extern char *conf_word(FILE *file, int allow_key);
519 extern void free_line(char *line);
520 extern int match_oneof(char *devices, char *devname);
521 extern void uuid_from_super(int uuid[4], mdp_super_t *super);
522 extern int same_uuid(int a[4], int b[4], int swapuuid);
523 extern void copy_uuid(void *a, int b[4], int swapuuid);
524 extern unsigned long calc_csum(void *super, int bytes);
525 extern int enough(int level, int raid_disks, int layout, int clean,
526                    char *avail, int avail_disks);
527 extern int ask(char *mesg);
528 extern unsigned long long get_component_size(int fd);
529 extern void remove_partitions(int fd);
530
531
532 extern char *human_size(long long bytes);
533 char *human_size_brief(long long bytes);
534
535 #define NoMdDev (1<<23)
536 extern int find_free_devnum(int use_partitions);
537
538 extern void put_md_name(char *name);
539 extern char *get_md_name(int dev);
540
541 extern char DefaultConfFile[];
542
543 extern int open_mddev(char *dev, int autof);
544 extern int open_mddev_devnum(char *devname, int devnum, char *name,
545                              char *chosen_name, int parts);
546
547
548 #define LEVEL_MULTIPATH         (-4)
549 #define LEVEL_LINEAR            (-1)
550 #define LEVEL_FAULTY            (-5)
551
552 /* kernel module doesn't know about these */
553 #define LEVEL_CONTAINER         (-100)
554
555
556 /* faulty stuff */
557
558 #define WriteTransient  0
559 #define ReadTransient   1
560 #define WritePersistent 2
561 #define ReadPersistent  3
562 #define WriteAll        4 /* doesn't go to device */
563 #define ReadFixable     5
564 #define Modes   6
565
566 #define ClearErrors     31
567 #define ClearFaults     30
568
569 #define AllPersist      100 /* internal use only */
570 #define NoPersist       101
571
572 #define ModeMask        0x1f
573 #define ModeShift       5
574
575
576 #ifdef __TINYC__
577 #undef minor
578 #undef major
579 #undef makedev
580 #define minor(x) ((x)&0xff)
581 #define major(x) (((x)>>8)&0xff)
582 #define makedev(M,m) (((M)<<8) | (m))
583 #endif
584
585 /* for raid5 */
586 #define ALGORITHM_LEFT_ASYMMETRIC       0
587 #define ALGORITHM_RIGHT_ASYMMETRIC      1
588 #define ALGORITHM_LEFT_SYMMETRIC        2
589 #define ALGORITHM_RIGHT_SYMMETRIC       3