Create a container member
[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; /* same as array.size, except in
146                                                  * sectors and up to 64bits.
147                                                  */
148         int                     reshape_active;
149         unsigned long long      reshape_progress;
150         int                     new_level, delta_disks, new_layout, new_chunk;
151         int                     errors;
152         int                     cache_size; /* size of raid456 stripe cache*/
153         int                     mismatch_cnt;
154         char                    text_version[50];
155
156         char            sys_name[20];
157         struct mdinfo *devs;
158         struct mdinfo *next;
159 };
160
161 struct createinfo {
162         int     uid;
163         int     gid;
164         int     autof;
165         int     mode;
166         int     symlinks;
167         struct supertype *supertype;
168 };
169
170 #define Name "mdadm"
171
172 enum mode {
173         ASSEMBLE=1,
174         BUILD,
175         CREATE,
176         MANAGE,
177         MISC,
178         MONITOR,
179         GROW,
180         INCREMENTAL,
181         AUTODETECT,
182 };
183
184 extern char short_options[];
185 extern char short_bitmap_options[];
186 extern char short_bitmap_auto_options[];
187 extern struct option long_options[];
188 extern char Version[], Usage[], Help[], OptionHelp[],
189         Help_create[], Help_build[], Help_assemble[], Help_grow[],
190         Help_incr[],
191         Help_manage[], Help_misc[], Help_monitor[], Help_config[];
192
193 /* for option that don't have short equivilents, we assign arbitrary
194  * small numbers.  '1' means an undecorated option, so we start at '2'.
195  */
196 enum special_options {
197         AssumeClean = 2,
198         BitmapChunk,
199         WriteBehind,
200         ReAdd,
201         NoDegraded,
202         Sparc22,
203         BackupFile,
204         HomeHost,
205         AutoHomeHost,
206         Symlinks,
207         AutoDetect,
208 };
209
210 /* structures read from config file */
211 /* List of mddevice names and identifiers
212  * Identifiers can be:
213  *    uuid=128-hex-uuid
214  *    super-minor=decimal-minor-number-from-superblock
215  *    devices=comma,separated,list,of,device,names,with,wildcards
216  *
217  * If multiple fields are present, the intersection of all matching
218  * devices is considered
219  */
220 #define UnSet (0xfffe)
221 typedef struct mddev_ident_s {
222         char    *devname;
223
224         int     uuid_set;
225         int     uuid[4];
226         char    name[33];
227
228         unsigned int super_minor;
229
230         char    *devices;       /* comma separated list of device
231                                  * names with wild cards
232                                  */
233         int     level;
234         unsigned int raid_disks;
235         unsigned int spare_disks;
236         struct supertype *st;
237         int     autof;          /* 1 for normal, 2 for partitioned */
238         char    *spare_group;
239         char    *bitmap_file;
240         int     bitmap_fd;
241
242         struct mddev_ident_s *next;
243 } *mddev_ident_t;
244
245 /* List of device names - wildcards expanded */
246 typedef struct mddev_dev_s {
247         char *devname;
248         char disposition;       /* 'a' for add, 'r' for remove, 'f' for fail.
249                                  * Not set for names read from .config
250                                  */
251         char writemostly;
252         char re_add;
253         char used;              /* set when used */
254         struct mddev_dev_s *next;
255 } *mddev_dev_t;
256
257 typedef struct mapping {
258         char *name;
259         int num;
260 } mapping_t;
261
262
263 struct mdstat_ent {
264         char            *dev;
265         int             devnum;
266         int             active;
267         char            *level;
268         char            *pattern; /* U or up, _ for down */
269         int             percent; /* -1 if no resync */
270         int             resync; /* 1 if resync, 0 if recovery */
271         struct mdstat_ent *next;
272 };
273
274 extern struct mdstat_ent *mdstat_read(int hold, int start);
275 extern void free_mdstat(struct mdstat_ent *ms);
276 extern void mdstat_wait(int seconds);
277 extern int mddev_busy(int devnum);
278
279 struct map_ent {
280         struct map_ent *next;
281         int     devnum;
282         int     major,minor;
283         int     uuid[4];
284         char    *path;
285 };
286 extern int map_update(struct map_ent **mpp, int devnum, int major, int minor,
287                       int uuid[4], char *path);
288 extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
289 extern void map_read(struct map_ent **melp);
290 extern int map_write(struct map_ent *mel);
291 extern void map_delete(struct map_ent **mapp, int devnum);
292 extern void map_free(struct map_ent *map);
293 extern void map_add(struct map_ent **melp,
294                     int devnum, int major, int minor, int uuid[4], char *path);
295
296 /* various details can be requested */
297 #define GET_LEVEL       1
298 #define GET_LAYOUT      2
299 #define GET_COMPONENT   4
300 #define GET_CHUNK       8
301 #define GET_CACHE       16
302 #define GET_MISMATCH    32
303 #define GET_VERSION     64
304
305 #define GET_DEVS        1024 /* gets role, major, minor */
306 #define GET_OFFSET      2048
307 #define GET_SIZE        4096
308 #define GET_STATE       8192
309 #define GET_ERROR       16384
310
311 /* If fd >= 0, get the array it is open on,
312  * else use devnum. >=0 -> major9. <0.....
313  */
314 extern void sysfs_free(struct mdinfo *sra);
315 extern struct mdinfo *sysfs_read(int fd, int devnum, unsigned long options);
316 extern int sysfs_set_str(struct mdinfo *sra, struct mdinfo *dev,
317                          char *name, char *val);
318 extern int sysfs_set_num(struct mdinfo *sra, struct mdinfo *dev,
319                          char *name, unsigned long long val);
320 extern int sysfs_get_ll(struct mdinfo *sra, struct mdinfo *dev,
321                         char *name, unsigned long long *val);
322 extern int sysfs_set_array(struct mdinfo *sra,
323                            struct mdinfo *info);
324 extern int sysfs_add_disk(struct mdinfo *sra, int fd, struct mdinfo *sd);
325
326
327
328
329 extern int save_stripes(int *source, unsigned long long *offsets,
330                         int raid_disks, int chunk_size, int level, int layout,
331                         int nwrites, int *dest,
332                         unsigned long long start, unsigned long long length);
333 extern int restore_stripes(int *dest, unsigned long long *offsets,
334                            int raid_disks, int chunk_size, int level, int layout,
335                            int source, unsigned long long read_offset,
336                            unsigned long long start, unsigned long long length);
337
338 #ifndef Sendmail
339 #define Sendmail "/usr/lib/sendmail -t"
340 #endif
341
342 #define SYSLOG_FACILITY LOG_DAEMON
343
344 extern char *map_num(mapping_t *map, int num);
345 extern int map_name(mapping_t *map, char *name);
346 extern mapping_t r5layout[], pers[], modes[], faultylayout[];
347
348 extern char *map_dev(int major, int minor, int create);
349
350
351 extern struct superswitch {
352         void (*examine_super)(struct supertype *st, char *homehost);
353         void (*brief_examine_super)(struct supertype *st);
354         void (*export_examine_super)(struct supertype *st);
355         void (*detail_super)(struct supertype *st, char *homehost);
356         void (*brief_detail_super)(struct supertype *st);
357         void (*export_detail_super)(struct supertype *st);
358         void (*uuid_from_super)(struct supertype *st, int uuid[4]);
359         void (*getinfo_super)(struct supertype *st, struct mdinfo *info);
360         void (*getinfo_super_n)(struct supertype *st, struct mdinfo *info);
361         int (*match_home)(struct supertype *st, char *homehost);
362         int (*update_super)(struct supertype *st, struct mdinfo *info,
363                             char *update,
364                             char *devname, int verbose,
365                             int uuid_set, char *homehost);
366         int (*init_super)(struct supertype *st, mdu_array_info_t *info,
367                           unsigned long long size, char *name,
368                           char *homehost, int *uuid);
369         void (*add_to_super)(struct supertype *st, mdu_disk_info_t *dinfo,
370                              int fd, char *devname);
371         int (*store_super)(struct supertype *st, int fd);
372         int (*write_init_super)(struct supertype *st);
373         int (*compare_super)(struct supertype *st, struct supertype *tst);
374         int (*load_super)(struct supertype *st, int fd, char *devname);
375         struct supertype * (*match_metadata_desc)(char *arg);
376         __u64 (*avail_size)(struct supertype *st, __u64 size);
377         int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
378                                    int delay, int write_behind,
379                                    unsigned long long size, int may_change, int major);
380         void (*locate_bitmap)(struct supertype *st, int fd);
381         int (*write_bitmap)(struct supertype *st, int fd);
382         void (*free_super)(struct supertype *st);
383         int (*validate_geometry)(struct supertype *st, int level, int layout,
384                                  int raiddisks,
385                                  int chunk, unsigned long long size,
386                                  char *subdev, unsigned long long *freesize);
387
388         struct mdinfo *(*container_content)(struct supertype *st);
389
390         int major;
391         char *text_version;
392         int swapuuid; /* true if uuid is bigending rather than hostendian */
393         int external;
394 } super0, super1, super_ddf, super_ddf_bvd, super_ddf_svd, *superlist[];
395
396 struct supertype {
397         struct superswitch *ss;
398         int minor_version;
399         int max_devs;
400         int container_dev;    /* devnum of container */
401         int container_member; /* numerical position in container */
402         void *sb;
403         void *info;
404 };
405
406 extern struct supertype *super_by_fd(int fd);
407 extern struct supertype *guess_super(int fd);
408 extern struct supertype *dup_super(struct supertype *st);
409 extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
410 extern void get_one_disk(int mdfd, mdu_array_info_t *ainf,
411                          mdu_disk_info_t *disk);
412
413 #if __GNUC__ < 3
414 struct stat64;
415 #endif
416
417 #define HAVE_NFTW  we assume
418 #define HAVE_FTW
419
420 #ifdef UCLIBC
421 # include <features.h>
422 # ifndef  __UCLIBC_HAS_FTW__
423 #  undef HAVE_FTW
424 #  undef HAVE_NFTW
425 # endif
426 #endif
427
428 #ifdef __dietlibc__
429 # undef HAVE_NFTW
430 #endif
431
432 #if defined(__KLIBC__)
433 # undef HAVE_NFTW
434 # undef HAVE_FTW
435 #endif
436
437 #ifndef HAVE_NFTW
438 # define FTW_PHYS 1
439 # ifndef HAVE_FTW
440   struct FTW {};
441 # endif
442 #endif
443
444 #ifdef HAVE_FTW
445 # include <ftw.h>
446 #endif
447
448 extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
449
450
451 extern int Manage_ro(char *devname, int fd, int readonly);
452 extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
453 extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
454 extern int Manage_reconfig(char *devname, int fd, int layout);
455 extern int Manage_subdevs(char *devname, int fd,
456                           mddev_dev_t devlist, int verbose);
457 extern int autodetect(void);
458 extern int Grow_Add_device(char *devname, int fd, char *newdev);
459 extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
460 extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
461                         long long size,
462                         int level, int layout, int chunksize, int raid_disks);
463 extern int Grow_restart(struct supertype *st, struct mdinfo *info,
464                         int *fdlist, int cnt, char *backup_file);
465
466
467 extern int Assemble(struct supertype *st, char *mddev, int mdfd,
468                     mddev_ident_t ident,
469                     mddev_dev_t devlist, char *backup_file,
470                     int readonly, int runstop,
471                     char *update, char *homehost,
472                     int verbose, int force);
473
474 extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
475                  int raiddisks,
476                  mddev_dev_t devlist, int assume_clean,
477                  char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int verbose);
478
479
480 extern int Create(struct supertype *st, char *mddev, int mdfd,
481                   int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
482                   char *name, char *homehost, int *uuid,
483                   int subdevs, mddev_dev_t devlist,
484                   int runstop, int verbose, int force, int assume_clean,
485                   char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
486
487 extern int Detail(char *dev, int brief, int export, int test, char *homehost);
488 extern int Query(char *dev);
489 extern int Examine(mddev_dev_t devlist, int brief, int export, int scan,
490                    int SparcAdjust, struct supertype *forcest, char *homehost);
491 extern int Monitor(mddev_dev_t devlist,
492                    char *mailaddr, char *alert_cmd,
493                    int period, int daemonise, int scan, int oneshot,
494                    int dosyslog, int test, char *pidfile);
495
496 extern int Kill(char *dev, int force, int quiet, int noexcl);
497 extern int Wait(char *dev);
498
499 extern int Incremental(char *devname, int verbose, int runstop,
500                        struct supertype *st, char *homehost, int autof);
501 extern int Incremental_container(struct supertype *st, char *devname,
502                                  int verbose, int runstop, int autof);
503 extern void RebuildMap(void);
504 extern int IncrementalScan(int verbose);
505
506 extern int CreateBitmap(char *filename, int force, char uuid[16],
507                         unsigned long chunksize, unsigned long daemon_sleep,
508                         unsigned long write_behind,
509                         unsigned long long array_size,
510                         int major);
511 extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
512 extern int bitmap_update_uuid(int fd, int *uuid, int swap);
513
514 extern int md_get_version(int fd);
515 extern int get_linux_version(void);
516 extern int parse_uuid(char *str, int uuid[4]);
517 extern int check_ext2(int fd, char *name);
518 extern int check_reiser(int fd, char *name);
519 extern int check_raid(int fd, char *name);
520
521 extern int get_mdp_major(void);
522 extern int dev_open(char *dev, int flags);
523 extern int is_standard(char *dev, int *nump);
524
525 extern int parse_auto(char *str, char *msg, int config);
526 extern mddev_ident_t conf_get_ident(char *dev);
527 extern mddev_dev_t conf_get_devs(void);
528 extern int conf_test_dev(char *devname);
529 extern struct createinfo *conf_get_create_info(void);
530 extern void set_conffile(char *file);
531 extern char *conf_get_mailaddr(void);
532 extern char *conf_get_mailfrom(void);
533 extern char *conf_get_program(void);
534 extern char *conf_get_homehost(void);
535 extern char *conf_line(FILE *file);
536 extern char *conf_word(FILE *file, int allow_key);
537 extern void free_line(char *line);
538 extern int match_oneof(char *devices, char *devname);
539 extern void uuid_from_super(int uuid[4], mdp_super_t *super);
540 extern int same_uuid(int a[4], int b[4], int swapuuid);
541 extern void copy_uuid(void *a, int b[4], int swapuuid);
542 extern unsigned long calc_csum(void *super, int bytes);
543 extern int enough(int level, int raid_disks, int layout, int clean,
544                    char *avail, int avail_disks);
545 extern int ask(char *mesg);
546 extern unsigned long long get_component_size(int fd);
547 extern void remove_partitions(int fd);
548 extern unsigned long long calc_array_size(int level, int raid_disks, int layout,
549                                    int chunksize, unsigned long long devsize);
550
551
552 extern char *human_size(long long bytes);
553 char *human_size_brief(long long bytes);
554
555 #define NoMdDev (1<<23)
556 extern int find_free_devnum(int use_partitions);
557
558 extern void put_md_name(char *name);
559 extern char *get_md_name(int dev);
560
561 extern char DefaultConfFile[];
562
563 extern int open_mddev(char *dev, int autof);
564 extern int open_mddev_devnum(char *devname, int devnum, char *name,
565                              char *chosen_name, int parts);
566 extern int open_container(int fd);
567
568 extern char *devnum2devname(int num);
569 extern int fd2devnum(int fd);
570
571 #define LEVEL_MULTIPATH         (-4)
572 #define LEVEL_LINEAR            (-1)
573 #define LEVEL_FAULTY            (-5)
574
575 /* kernel module doesn't know about these */
576 #define LEVEL_CONTAINER         (-100)
577 #define LEVEL_UNSUPPORTED       (-200)
578
579
580 /* faulty stuff */
581
582 #define WriteTransient  0
583 #define ReadTransient   1
584 #define WritePersistent 2
585 #define ReadPersistent  3
586 #define WriteAll        4 /* doesn't go to device */
587 #define ReadFixable     5
588 #define Modes   6
589
590 #define ClearErrors     31
591 #define ClearFaults     30
592
593 #define AllPersist      100 /* internal use only */
594 #define NoPersist       101
595
596 #define ModeMask        0x1f
597 #define ModeShift       5
598
599
600 #ifdef __TINYC__
601 #undef minor
602 #undef major
603 #undef makedev
604 #define minor(x) ((x)&0xff)
605 #define major(x) (((x)>>8)&0xff)
606 #define makedev(M,m) (((M)<<8) | (m))
607 #endif
608
609 /* for raid5 */
610 #define ALGORITHM_LEFT_ASYMMETRIC       0
611 #define ALGORITHM_RIGHT_ASYMMETRIC      1
612 #define ALGORITHM_LEFT_SYMMETRIC        2
613 #define ALGORITHM_RIGHT_SYMMETRIC       3