[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


#include	"md_u.h"
#include	"md_p.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;
	__u32	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;
	int	autof;		/* 1 for normal, 2 for partitioned */
	char	*spare_group;

	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 int Manage_ro(char *devname, int fd, int readonly);
extern int Manage_runstop(char *devname, int fd, int runstop);
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 Assemble(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);


extern int Create(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);

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);
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 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 store_super(int fd, mdp_super_t *super);
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

extern void examine_super0(void *sbv);
extern void brief_examine_super0(void *sbv);
extern void detail_super0(void *sbv);
extern void brief_detail_super0(void *sbv);
extern void getinfo_super0(struct mdinfo *info, void *sbv);
extern int update_super0(struct mdinfo *info, void *sbv, char *update, char *devname, int verbose);
extern __u64 event_super0(void *sbv);
extern void uuid_from_super0(int uuid[4], void * sbv);
extern void init_super0(void **sbv, mdu_array_info_t *info);
extern void add_to_super0(void *sbp, mdu_disk_info_t *dinfo);
extern int store_super0(int fd, mdp_super_t *super);
extern int write_init_super0(void *sbv, mdu_disk_info_t *dinfo, char *devname);
extern int load_super0(int fd, void **super, char *devname);
extern int compare_super0(void **first, void *second);
Commit	Line	Data
64c4757e	1	/*
9a9dab36	2	* mdadm - manage Linux "md" devices aka RAID arrays.
64c4757e	3	*
cd29a5c8	4	* Copyright (C) 2001-2002 Neil Brown <neilb@cse.unsw.edu.au>
64c4757e NB	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>
98c6faba	32	#ifndef __dietlibc__
64c4757e	33	extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
98c6faba	34	#endif
64c4757e NB	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>
98c6faba NB	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
64c4757e NB	51
64c4757e NB	52	#include <linux/kdev_t.h>
e0d19036 NB	53	/#include <linux/fs.h> /
	54	#include <sys/mount.h>
	55	#include <asm/types.h>
64c4757e NB	56	#include <sys/ioctl.h>
64c4757e NB	57	#define MD_MAJOR 9
dd0781e5	58	#define MdpMinorShift 6
64c4757e	59
e0d19036	60	#ifndef BLKGETSIZE64
98c6faba	61	#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 arg) /
e0d19036	62	#endif
56eb10c0	63
64c4757e NB	64
64c4757e NB	65	#include "md_u.h"
e0d19036	66	#include "md_p.h"
64c4757e	67
4b1ac34b NB	68	/* general information that might be extracted from a superblock */
	69	struct mdinfo {
	70	mdu_array_info_t array;
	71	mdu_disk_info_t disk;
	72	__u64 events;
	73	unsigned int uuid[4];
	74	};
	75
9a9dab36	76	#define Name "mdadm"
682c7051	77
e0d19036 NB	78	enum mode {
	79	ASSEMBLE=1,
	80	BUILD,
	81	CREATE,
	82	MANAGE,
	83	MISC,
	84	MONITOR,
dd0781e5	85	GROW,
e0d19036 NB	86	};
e0d19036 NB	87
64c4757e NB	88	extern char short_options[];
64c4757e NB	89	extern struct option long_options[];
56eedc1a	90	extern char Version[], Usage[], Help[], OptionHelp[],
dd0781e5	91	Help_create[], Help_build[], Help_assemble[], Help_grow[],
e0d19036	92	Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e NB	93
64c4757e NB	94	/* structures read from config file */
52826846 NB	95	/* List of mddevice names and identifiers
	96	* Identifiers can be:
	97	* uuid=128-hex-uuid
	98	* super-minor=decimal-minor-number-from-superblock
	99	* devices=comma,separated,list,of,device,names,with,wildcards
	100	*
	101	* If multiple fields are present, the intersection of all matching
	102	* devices is considered
	103	*/
98c6faba	104	#define UnSet (0xfffe)
52826846	105	typedef struct mddev_ident_s {
dd0781e5	106	char *devname;
52826846	107
dd0781e5 NB	108	int uuid_set;
dd0781e5 NB	109	__u32 uuid[4];
52826846	110
98c6faba	111	unsigned int super_minor;
52826846	112
dd0781e5	113	char devices; / comma separated list of device
52826846 NB	114	* names with wild cards
52826846 NB	115	*/
dd0781e5	116	int level;
98c6faba NB	117	unsigned int raid_disks;
98c6faba NB	118	unsigned int spare_disks;
dd0781e5 NB	119	int autof; /* 1 for normal, 2 for partitioned */
	120	char *spare_group;
	121
52826846 NB	122	struct mddev_ident_s *next;
52826846 NB	123	} *mddev_ident_t;
64c4757e NB	124
	125	/* List of device names - wildcards expanded */
	126	typedef struct mddev_dev_s {
	127	char *devname;
cd29a5c8 NB	128	char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
	129	* Not set for names read from .config
	130	*/
64c4757e NB	131	struct mddev_dev_s *next;
	132	} *mddev_dev_t;
	133
682c7051 NB	134	typedef struct mapping {
	135	char *name;
	136	int num;
	137	} mapping_t;
	138
e0d19036 NB	139
	140	struct mdstat_ent {
	141	char *dev;
	142	int devnum;
	143	int active;
	144	char *level;
	145	char pattern; / U or up, _ for down */
	146	int percent; /* -1 if no resync */
e5329c37	147	int resync; /* 1 if resync, 0 if recovery */
e0d19036 NB	148	struct mdstat_ent *next;
	149	};
	150
dd0781e5	151	extern struct mdstat_ent *mdstat_read(int);
e0d19036	152	extern void free_mdstat(struct mdstat_ent *ms);
dd0781e5	153	extern void mdstat_wait(int seconds);
e0d19036	154
52826846 NB	155	#ifndef Sendmail
	156	#define Sendmail "/usr/lib/sendmail -t"
	157	#endif
	158
682c7051 NB	159	extern char map_num(mapping_t map, int num);
682c7051 NB	160	extern int map_name(mapping_t map, char name);
b5e64645	161	extern mapping_t r5layout[], pers[], modes[], faultylayout[];
682c7051	162
82b27616	163	extern char *map_dev(int major, int minor);
64c4757e NB	164
	165
	166	extern int Manage_ro(char *devname, int fd, int readonly);
	167	extern int Manage_runstop(char *devname, int fd, int runstop);
dd0781e5	168	extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
b5e64645	169	extern int Manage_reconfig(char *devname, int fd, int layout);
64c4757e	170	extern int Manage_subdevs(char *devname, int fd,
cd29a5c8	171	mddev_dev_t devlist);
e5329c37	172	extern int Grow_Add_device(char devname, int fd, char newdev);
64c4757e NB	173
	174
	175	extern int Assemble(char *mddev, int mdfd,
52826846 NB	176	mddev_ident_t ident,
52826846 NB	177	char *conffile,
cd29a5c8	178	mddev_dev_t devlist,
64c4757e	179	int readonly, int runstop,
5787fa49	180	char *update,
64c4757e NB	181	int verbose, int force);
64c4757e NB	182
b5e64645	183	extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
64c4757e	184	int raiddisks,
dd0781e5	185	mddev_dev_t devlist, int assume_clean);
64c4757e NB	186
	187
	188	extern int Create(char *mddev, int mdfd,
aa88f531	189	int chunk, int level, int layout, unsigned long size, int raiddisks, int sparedisks,
cd29a5c8	190	int subdevs, mddev_dev_t devlist,
52826846	191	int runstop, int verbose, int force);
64c4757e	192
feb716e9	193	extern int Detail(char *dev, int brief, int test);
e0d19036	194	extern int Query(char *dev);
bd526cee	195	extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust);
cd29a5c8	196	extern int Monitor(mddev_dev_t devlist,
e0d19036	197	char mailaddr, char alert_cmd,
aa88f531	198	int period, int daemonise, int scan, int oneshot,
b5e64645	199	char config, int test, char pidfile);
64c4757e	200
9a9dab36 NB	201	extern int Kill(char *dev, int force);
9a9dab36 NB	202
64c4757e	203	extern int md_get_version(int fd);
e0d19036	204	extern int get_linux_version(void);
64c4757e	205	extern int parse_uuid(char *str, int uuid[4]);
682c7051 NB	206	extern int check_ext2(int fd, char *name);
	207	extern int check_reiser(int fd, char *name);
	208	extern int check_raid(int fd, char *name);
64c4757e	209
dd0781e5	210	extern int get_mdp_major(void);
8d80900b	211	extern int is_standard(char dev, int nump);
dd0781e5 NB	212
dd0781e5 NB	213
e0d19036 NB	214	extern mddev_ident_t conf_get_ident(char conffile, char dev);
	215	extern mddev_dev_t conf_get_devs(char *conffile);
	216	extern char conf_get_mailaddr(char conffile);
	217	extern char conf_get_program(char conffile);
	218	extern char conf_line(FILE file);
98c6faba	219	extern char conf_word(FILE file, int allow_key);
e0d19036 NB	220	extern void free_line(char *line);
e0d19036 NB	221	extern int match_oneof(char devices, char devname);
e0d19036 NB	222	extern void uuid_from_super(int uuid[4], mdp_super_t *super);
e0d19036 NB	223	extern int same_uuid(int a[4], int b[4]);
4b1ac34b NB	224	/* extern int compare_super(mdp_super_t first, mdp_super_t second);*/
4b1ac34b NB	225	extern unsigned long calc_csum(void *super, int bytes);
e0d19036 NB	226	extern int store_super(int fd, mdp_super_t *super);
	227	extern int enough(int level, int raid_disks, int avail_disks);
	228	extern int ask(char *mesg);
	229
cd29a5c8	230
56eb10c0	231	extern char *human_size(long long bytes);
e0d19036 NB	232	char *human_size_brief(long long bytes);
	233
	234	extern void put_md_name(char *name);
	235	extern char *get_md_name(int dev);
	236
c913b90e	237	extern char DefaultConfFile[];
b5e64645 NB	238
	239	extern int open_mddev(char *dev, int autof);
	240
	241
	242	#define LEVEL_MULTIPATH (-4)
	243	#define LEVEL_LINEAR (-1)
	244	#define LEVEL_FAULTY (-5)
	245
	246
	247	/* faulty stuff */
	248
	249	#define WriteTransient 0
	250	#define ReadTransient 1
	251	#define WritePersistent 2
	252	#define ReadPersistent 3
	253	#define WriteAll 4 /* doesn't go to device */
	254	#define ReadFixable 5
	255	#define Modes 6
	256
	257	#define ClearErrors 31
	258	#define ClearFaults 30
	259
	260	#define AllPersist 100 /* internal use only */
	261	#define NoPersist 101
	262
	263	#define ModeMask 0x1f
	264	#define ModeShift 5
4b1ac34b NB	265
	266	extern void examine_super0(void *sbv);
	267	extern void brief_examine_super0(void *sbv);
	268	extern void detail_super0(void *sbv);
	269	extern void brief_detail_super0(void *sbv);
	270	extern void getinfo_super0(struct mdinfo info, void sbv);
	271	extern int update_super0(struct mdinfo info, void sbv, char update, char devname, int verbose);
	272	extern __u64 event_super0(void *sbv);
	273	extern void uuid_from_super0(int uuid[4], void * sbv);
	274	extern void init_super0(void *sbv, mdu_array_info_t info);
	275	extern void add_to_super0(void sbp, mdu_disk_info_t dinfo);
	276	extern int store_super0(int fd, mdp_super_t *super);
	277	extern int write_init_super0(void sbv, mdu_disk_info_t dinfo, char *devname);
	278	extern int load_super0(int fd, void *super, char devname);
	279	extern int compare_super0(void *first, void second);