[thirdparty/mdadm.git] / mdadm.h

/*
 * mdadm - manage Linux "md" devices aka RAID arrays.
 *
 * Copyright (C) 2001-2002 Neil Brown <neilb@cse.unsw.edu.au>
 *
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *    Author: Neil Brown
 *    Email: <neilb@cse.unsw.edu.au>
 *    Paper: Neil Brown
 *           School of Computer Science and Engineering
 *           The University of New South Wales
 *           Sydney, 2052
 *           Australia
 */

#define	__USE_LARGEFILE64
#include	<unistd.h>
#ifndef __dietlibc__
extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
#endif

#include	<sys/types.h>
#include	<sys/stat.h>
#include	<stdlib.h>
#include	<time.h>
#include	<getopt.h>
#include	<fcntl.h>
#include	<stdio.h>
#include	<errno.h>
#include	<string.h>
#ifdef __dietlibc__NONO
int strncmp(const char *s1, const char *s2, size_t n) __THROW __pure__;
char *strncpy(char *dest, const char *src, size_t n) __THROW;
#include    <strings.h>
#endif


#include	<linux/kdev_t.h>
/*#include	<linux/fs.h> */
#include	<sys/mount.h>
#include	<asm/types.h>
#include	<sys/ioctl.h>
#define	MD_MAJOR 9
#define MdpMinorShift 6

#ifndef BLKGETSIZE64
#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
#endif

#define DEFAULT_BITMAP_CHUNK 4096
#define DEFAULT_BITMAP_DELAY 5

#include	"md_u.h"
#include	"md_p.h"
#include	"bitmap.h"

/* general information that might be extracted from a superblock */
struct mdinfo {
	mdu_array_info_t	array;
	mdu_disk_info_t		disk;
	__u64			events;
	unsigned int		uuid[4];
};

#define Name "mdadm"

enum mode {
	ASSEMBLE=1,
	BUILD,
	CREATE,
	MANAGE,
	MISC,
	MONITOR,
	GROW,
};

extern char short_options[];
extern struct option long_options[];
extern char Version[], Usage[], Help[], OptionHelp[],
	Help_create[], Help_build[], Help_assemble[], Help_grow[],
	Help_manage[], Help_misc[], Help_monitor[], Help_config[];

/* structures read from config file */
/* List of mddevice names and identifiers
 * Identifiers can be:
 *    uuid=128-hex-uuid
 *    super-minor=decimal-minor-number-from-superblock
 *    devices=comma,separated,list,of,device,names,with,wildcards
 *
 * If multiple fields are present, the intersection of all matching
 * devices is considered
 */
#define UnSet (0xfffe)
typedef struct mddev_ident_s {
	char	*devname;
	
	int	uuid_set;
	int	uuid[4];

	unsigned int super_minor;

	char	*devices;	/* comma separated list of device
				 * names with wild cards
				 */
	int	level;
	unsigned int raid_disks;
	unsigned int spare_disks;
	struct supertype *st;
	int	autof;		/* 1 for normal, 2 for partitioned */
	char	*spare_group;
	int	bitmap_fd;

	struct mddev_ident_s *next;
} *mddev_ident_t;

/* List of device names - wildcards expanded */
typedef struct mddev_dev_s {
	char *devname;
	char disposition;	/* 'a' for add, 'r' for remove, 'f' for fail.
				 * Not set for names read from .config
				 */
	struct mddev_dev_s *next;
} *mddev_dev_t;

typedef struct mapping {
	char *name;
	int num;
} mapping_t;


struct mdstat_ent {
	char		*dev;
	int		devnum;
	int		active;
	char		*level;
	char		*pattern; /* U or up, _ for down */
	int		percent; /* -1 if no resync */
	int		resync; /* 1 if resync, 0 if recovery */
	struct mdstat_ent *next;
};

extern struct mdstat_ent *mdstat_read(int);
extern void free_mdstat(struct mdstat_ent *ms);
extern void mdstat_wait(int seconds);

#ifndef Sendmail
#define Sendmail "/usr/lib/sendmail -t"
#endif

extern char *map_num(mapping_t *map, int num);
extern int map_name(mapping_t *map, char *name);
extern mapping_t r5layout[], pers[], modes[], faultylayout[];

extern char *map_dev(int major, int minor);


extern struct superswitch {
	void (*examine_super)(void *sbv);
	void (*brief_examine_super)(void *sbv);
	void (*detail_super)(void *sbv);
	void (*brief_detail_super)(void *sbv);
	void (*uuid_from_super)(int uuid[4], void *sbv);
	void (*getinfo_super)(struct mdinfo *info, void *sbv);
	int (*update_super)(struct mdinfo *info, void *sbv, char *update, char *devname, int verbose);
	__u64 (*event_super)(void *sbv);
	int (*init_super)(struct supertype *st, void **sbp, mdu_array_info_t *info);
	void (*add_to_super)(void *sbv, mdu_disk_info_t *dinfo);
	int (*store_super)(struct supertype *st, int fd, void *sbv);
	int (*write_init_super)(struct supertype *st, void *sbv, mdu_disk_info_t *dinfo, char *devname);
	int (*compare_super)(void **firstp, void *secondv);
	int (*load_super)(struct supertype *st, int fd, void **sbp, char *devname);
	struct supertype * (*match_metadata_desc)(char *arg);
	__u64 (*avail_size)(__u64 size);
	int (*add_internal_bitmap)(void *sbv, int chunk, int delay, unsigned long long size);
	void (*locate_bitmap)(struct supertype *st, int fd);
	int (*write_bitmap)(struct supertype *st, int fd, void *sbv);
	int major;
} super0, super1, *superlist[];

struct supertype {
	struct superswitch *ss;
	int minor_version;
	int max_devs;
};

extern struct supertype *super_by_version(int vers, int minor);
extern struct supertype *guess_super(int fd);


extern int Manage_ro(char *devname, int fd, int readonly);
extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
extern int Manage_reconfig(char *devname, int fd, int layout);
extern int Manage_subdevs(char *devname, int fd,
			  mddev_dev_t devlist);
extern int Grow_Add_device(char *devname, int fd, char *newdev);
extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay);


extern int Assemble(struct supertype *st, char *mddev, int mdfd,
		    mddev_ident_t ident,
		    char *conffile,
		    mddev_dev_t devlist,
		    int readonly, int runstop,
		    char *update,
		    int verbose, int force);

extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
		 int raiddisks,
		 mddev_dev_t devlist, int assume_clean,
		 char *bitmap_file, int bitmap_chunk, int delay);


extern int Create(struct supertype *st, char *mddev, int mdfd,
		  int chunk, int level, int layout, unsigned long size, int raiddisks, int sparedisks,
		  int subdevs, mddev_dev_t devlist,
		  int runstop, int verbose, int force,
		  char *bitmap_file, int bitmap_chunk, int delay);

extern int Detail(char *dev, int brief, int test);
extern int Query(char *dev);
extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
		   struct supertype *forcest);
extern int Monitor(mddev_dev_t devlist,
		   char *mailaddr, char *alert_cmd,
		   int period, int daemonise, int scan, int oneshot,
		   char *config, int test, char *pidfile);

extern int Kill(char *dev, int force);

extern int CreateBitmap(char *filename, int force, char uuid[16],
			unsigned long chunksize, unsigned long daemon_sleep,
			unsigned long long array_size);
extern int ExamineBitmap(char *filename, int brief, struct supertype *st);

extern int md_get_version(int fd);
extern int get_linux_version(void);
extern int parse_uuid(char *str, int uuid[4]);
extern int check_ext2(int fd, char *name);
extern int check_reiser(int fd, char *name);
extern int check_raid(int fd, char *name);

extern int get_mdp_major(void);
extern int is_standard(char *dev, int *nump);


extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
extern mddev_dev_t conf_get_devs(char *conffile);
extern char *conf_get_mailaddr(char *conffile);
extern char *conf_get_program(char *conffile);
extern char *conf_line(FILE *file);
extern char *conf_word(FILE *file, int allow_key);
extern void free_line(char *line);
extern int match_oneof(char *devices, char *devname);
extern void uuid_from_super(int uuid[4], mdp_super_t *super);
extern int same_uuid(int a[4], int b[4]);
/* extern int compare_super(mdp_super_t *first, mdp_super_t *second);*/
extern unsigned long calc_csum(void *super, int bytes);
extern int enough(int level, int raid_disks, int avail_disks);
extern int ask(char *mesg);


extern char *human_size(long long bytes);
char *human_size_brief(long long bytes);

extern void put_md_name(char *name);
extern char *get_md_name(int dev);

extern char DefaultConfFile[];

extern int open_mddev(char *dev, int autof);


#define	LEVEL_MULTIPATH		(-4)
#define	LEVEL_LINEAR		(-1)
#define	LEVEL_FAULTY		(-5)


/* faulty stuff */

#define	WriteTransient	0
#define	ReadTransient	1
#define	WritePersistent	2
#define	ReadPersistent	3
#define	WriteAll	4 /* doesn't go to device */
#define	ReadFixable	5
#define	Modes	6

#define	ClearErrors	31
#define	ClearFaults	30

#define AllPersist	100 /* internal use only */
#define	NoPersist	101

#define	ModeMask	0x1f
#define	ModeShift	5
Commit	Line	Data
	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 <getopt.h>
	41	#include <fcntl.h>
	42	#include <stdio.h>
	43	#include <errno.h>
	44	#include <string.h>
	45	#ifdef __dietlibc__NONO
	46	int strncmp(const char s1, const char s2, size_t n) __THROW __pure__;
	47	char strncpy(char dest, const char *src, size_t n) __THROW;
	48	#include <strings.h>
	49	#endif
	50
	51
	52	#include <linux/kdev_t.h>
	53	/#include <linux/fs.h> /
	54	#include <sys/mount.h>
	55	#include <asm/types.h>
	56	#include <sys/ioctl.h>
	57	#define MD_MAJOR 9
	58	#define MdpMinorShift 6
	59
	60	#ifndef BLKGETSIZE64
	61	#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 arg) /
	62	#endif
	63
	64	#define DEFAULT_BITMAP_CHUNK 4096
	65	#define DEFAULT_BITMAP_DELAY 5
	66
	67	#include "md_u.h"
	68	#include "md_p.h"
	69	#include "bitmap.h"
	70
	71	/* general information that might be extracted from a superblock */
	72	struct mdinfo {
	73	mdu_array_info_t array;
	74	mdu_disk_info_t disk;
	75	__u64 events;
	76	unsigned int uuid[4];
	77	};
	78
	79	#define Name "mdadm"
	80
	81	enum mode {
	82	ASSEMBLE=1,
	83	BUILD,
	84	CREATE,
	85	MANAGE,
	86	MISC,
	87	MONITOR,
	88	GROW,
	89	};
	90
	91	extern char short_options[];
	92	extern struct option long_options[];
	93	extern char Version[], Usage[], Help[], OptionHelp[],
	94	Help_create[], Help_build[], Help_assemble[], Help_grow[],
	95	Help_manage[], Help_misc[], Help_monitor[], Help_config[];
	96
	97	/* structures read from config file */
	98	/* List of mddevice names and identifiers
	99	* Identifiers can be:
	100	* uuid=128-hex-uuid
	101	* super-minor=decimal-minor-number-from-superblock
	102	* devices=comma,separated,list,of,device,names,with,wildcards
	103	*
	104	* If multiple fields are present, the intersection of all matching
	105	* devices is considered
	106	*/
	107	#define UnSet (0xfffe)
	108	typedef struct mddev_ident_s {
	109	char *devname;
	110
	111	int uuid_set;
	112	int uuid[4];
	113
	114	unsigned int super_minor;
	115
	116	char devices; / comma separated list of device
	117	* names with wild cards
	118	*/
	119	int level;
	120	unsigned int raid_disks;
	121	unsigned int spare_disks;
	122	struct supertype *st;
	123	int autof; /* 1 for normal, 2 for partitioned */
	124	char *spare_group;
	125	int bitmap_fd;
	126
	127	struct mddev_ident_s *next;
	128	} *mddev_ident_t;
	129
	130	/* List of device names - wildcards expanded */
	131	typedef struct mddev_dev_s {
	132	char *devname;
	133	char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
	134	* Not set for names read from .config
	135	*/
	136	struct mddev_dev_s *next;
	137	} *mddev_dev_t;
	138
	139	typedef struct mapping {
	140	char *name;
	141	int num;
	142	} mapping_t;
	143
	144
	145	struct mdstat_ent {
	146	char *dev;
	147	int devnum;
	148	int active;
	149	char *level;
	150	char pattern; / U or up, _ for down */
	151	int percent; /* -1 if no resync */
	152	int resync; /* 1 if resync, 0 if recovery */
	153	struct mdstat_ent *next;
	154	};
	155
	156	extern struct mdstat_ent *mdstat_read(int);
	157	extern void free_mdstat(struct mdstat_ent *ms);
	158	extern void mdstat_wait(int seconds);
	159
	160	#ifndef Sendmail
	161	#define Sendmail "/usr/lib/sendmail -t"
	162	#endif
	163
	164	extern char map_num(mapping_t map, int num);
	165	extern int map_name(mapping_t map, char name);
	166	extern mapping_t r5layout[], pers[], modes[], faultylayout[];
	167
	168	extern char *map_dev(int major, int minor);
	169
	170
	171	extern struct superswitch {
	172	void (examine_super)(void sbv);
	173	void (brief_examine_super)(void sbv);
	174	void (detail_super)(void sbv);
	175	void (brief_detail_super)(void sbv);
	176	void (uuid_from_super)(int uuid[4], void sbv);
	177	void (getinfo_super)(struct mdinfo info, void *sbv);
	178	int (update_super)(struct mdinfo info, void sbv, char update, char *devname, int verbose);
	179	__u64 (event_super)(void sbv);
	180	int (init_super)(struct supertype st, void *sbp, mdu_array_info_t info);
	181	void (add_to_super)(void sbv, mdu_disk_info_t *dinfo);
	182	int (store_super)(struct supertype st, int fd, void *sbv);
	183	int (write_init_super)(struct supertype st, void sbv, mdu_disk_info_t dinfo, char *devname);
	184	int (compare_super)(void firstp, void secondv);
	185	int (load_super)(struct supertype st, int fd, void *sbp, char devname);
	186	struct supertype * (match_metadata_desc)(char arg);
	187	__u64 (*avail_size)(__u64 size);
	188	int (add_internal_bitmap)(void sbv, int chunk, int delay, unsigned long long size);
	189	void (locate_bitmap)(struct supertype st, int fd);
	190	int (write_bitmap)(struct supertype st, int fd, void *sbv);
	191	int major;
	192	} super0, super1, *superlist[];
	193
	194	struct supertype {
	195	struct superswitch *ss;
	196	int minor_version;
	197	int max_devs;
	198	};
	199
	200	extern struct supertype *super_by_version(int vers, int minor);
	201	extern struct supertype *guess_super(int fd);
	202
	203
	204	extern int Manage_ro(char *devname, int fd, int readonly);
	205	extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
	206	extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
	207	extern int Manage_reconfig(char *devname, int fd, int layout);
	208	extern int Manage_subdevs(char *devname, int fd,
	209	mddev_dev_t devlist);
	210	extern int Grow_Add_device(char devname, int fd, char newdev);
	211	extern int Grow_addbitmap(char devname, int fd, char file, int chunk, int delay);
	212
	213
	214	extern int Assemble(struct supertype st, char mddev, int mdfd,
	215	mddev_ident_t ident,
	216	char *conffile,
	217	mddev_dev_t devlist,
	218	int readonly, int runstop,
	219	char *update,
	220	int verbose, int force);
	221
	222	extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
	223	int raiddisks,
	224	mddev_dev_t devlist, int assume_clean,
	225	char *bitmap_file, int bitmap_chunk, int delay);
	226
	227
	228	extern int Create(struct supertype st, char mddev, int mdfd,
	229	int chunk, int level, int layout, unsigned long size, int raiddisks, int sparedisks,
	230	int subdevs, mddev_dev_t devlist,
	231	int runstop, int verbose, int force,
	232	char *bitmap_file, int bitmap_chunk, int delay);
	233
	234	extern int Detail(char *dev, int brief, int test);
	235	extern int Query(char *dev);
	236	extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
	237	struct supertype *forcest);
	238	extern int Monitor(mddev_dev_t devlist,
	239	char mailaddr, char alert_cmd,
	240	int period, int daemonise, int scan, int oneshot,
	241	char config, int test, char pidfile);
	242
	243	extern int Kill(char *dev, int force);
	244
	245	extern int CreateBitmap(char *filename, int force, char uuid[16],
	246	unsigned long chunksize, unsigned long daemon_sleep,
	247	unsigned long long array_size);
	248	extern int ExamineBitmap(char filename, int brief, struct supertype st);
	249
	250	extern int md_get_version(int fd);
	251	extern int get_linux_version(void);
	252	extern int parse_uuid(char *str, int uuid[4]);
	253	extern int check_ext2(int fd, char *name);
	254	extern int check_reiser(int fd, char *name);
	255	extern int check_raid(int fd, char *name);
	256
	257	extern int get_mdp_major(void);
	258	extern int is_standard(char dev, int nump);
	259
	260
	261	extern mddev_ident_t conf_get_ident(char conffile, char dev);
	262	extern mddev_dev_t conf_get_devs(char *conffile);
	263	extern char conf_get_mailaddr(char conffile);
	264	extern char conf_get_program(char conffile);
	265	extern char conf_line(FILE file);
	266	extern char conf_word(FILE file, int allow_key);
	267	extern void free_line(char *line);
	268	extern int match_oneof(char devices, char devname);
	269	extern void uuid_from_super(int uuid[4], mdp_super_t *super);
	270	extern int same_uuid(int a[4], int b[4]);
	271	/* extern int compare_super(mdp_super_t first, mdp_super_t second);*/
	272	extern unsigned long calc_csum(void *super, int bytes);
	273	extern int enough(int level, int raid_disks, int avail_disks);
	274	extern int ask(char *mesg);
	275
	276
	277	extern char *human_size(long long bytes);
	278	char *human_size_brief(long long bytes);
	279
	280	extern void put_md_name(char *name);
	281	extern char *get_md_name(int dev);
	282
	283	extern char DefaultConfFile[];
	284
	285	extern int open_mddev(char *dev, int autof);
	286
	287
	288	#define LEVEL_MULTIPATH (-4)
	289	#define LEVEL_LINEAR (-1)
	290	#define LEVEL_FAULTY (-5)
	291
	292
	293	/* faulty stuff */
	294
	295	#define WriteTransient 0
	296	#define ReadTransient 1
	297	#define WritePersistent 2
	298	#define ReadPersistent 3
	299	#define WriteAll 4 /* doesn't go to device */
	300	#define ReadFixable 5
	301	#define Modes 6
	302
	303	#define ClearErrors 31
	304	#define ClearFaults 30
	305
	306	#define AllPersist 100 /* internal use only */
	307	#define NoPersist 101
	308
	309	#define ModeMask 0x1f
	310	#define ModeShift 5