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