[thirdparty/mdadm.git] / Examine.c

/*
 * 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
 */

#include	"mdadm.h"
#include	"dlink.h"

#if ! defined(__BIG_ENDIAN) && ! defined(__LITTLE_ENDIAN)
#error no endian defined
#endif
#include	"md_u.h"
#include	"md_p.h"
int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust)
{

	/* Read the raid superblock from a device and
	 * display important content.
	 *
	 * If cannot be found, print reason: too small, bad magic
	 *
	 * Print:
	 *   version, ctime, level, size, raid+spare+
	 *   prefered minor
	 *   uuid
	 *
	 *   utime, state etc
	 *
	 * If (brief) gather devices for same array and just print a mdadm.conf line including devices=
	 * if devlist==NULL, use conf_get_devs(
	 */
	int fd; 
	time_t atime;
	mdp_super_t super;
	int d;
	char *c;
	int rv = 0;
	int err;
	int spares = 0;

	struct array {
		mdp_super_t super;
		void *devs;
		struct array *next;
	} *arrays = NULL;

	for (; devlist ; devlist=devlist->next) {
		fd = open(devlist->devname, O_RDONLY);
		if (fd < 0) {
			if (!scan)
				fprintf(stderr,Name ": cannot open %s: %s\n",
					devlist->devname, strerror(errno));
			err = 1;
		}
		else {
			err = load_super(fd, &super);
			close(fd);
		}
		if (err && (brief||scan))
			continue;
		if (err) rv =1;
		switch(err) {
		case 1:
			fprintf(stderr, Name ": cannot find device size for %s: %s\n",
				devlist->devname, strerror(errno));
			continue;
		case 2:
/*		fprintf(stderr, Name ": %s is too small for md: size is %ld sectors\n",
		devlist->devname, size);
*/
			fprintf(stderr, Name ": %s is too small for md\n",
				devlist->devname);
			continue;
		case 3:
			fprintf(stderr, Name ": Cannot seek to superblock on %s: %s\n",
				devlist->devname, strerror(errno));
			continue;
		case 4:
			fprintf(stderr, Name ": Cannot read superblock on %s\n",
				devlist->devname);
			continue;
		case 5:
			fprintf(stderr, Name ": No super block found on %s (Expected magic %08x, got %08x)\n",
				devlist->devname, MD_SB_MAGIC, super.md_magic);
			continue;
		case 6:
			fprintf(stderr, Name ": Cannot interpret superblock on %s - version is %d\n",
				devlist->devname, super.major_version);
			continue;
		}
    
		/* Ok, its good enough to try, though the checksum could be wrong */
		if (brief) {
			struct array *ap;
			char *d;
			for (ap=arrays; ap; ap=ap->next) {
				if (compare_super(&ap->super, &super)==0)
					break;
			}
			if (!ap) {
				ap = malloc(sizeof(*ap));
				ap->super = super;
				ap->devs = dl_head();
				ap->next = arrays;
				arrays = ap;
			}
			d = dl_strdup(devlist->devname);
			dl_add(ap->devs, d);
		} else {
			printf("%s:\n",devlist->devname);
			printf("          Magic : %08x\n", super.md_magic);
			printf("        Version : %02d.%02d.%02d\n", super.major_version, super.minor_version,
			       super.patch_version);
			if (super.minor_version >= 90)
				printf("           UUID : %08x:%08x:%08x:%08x\n", super.set_uuid0, super.set_uuid1,
				       super.set_uuid2, super.set_uuid3);
			else
				printf("           UUID : %08x\n", super.set_uuid0);

			atime = super.ctime;
			printf("  Creation Time : %.24s\n", ctime(&atime));
			c=map_num(pers, super.level);
			printf("     Raid Level : %s\n", c?c:"-unknown-");
			printf("    Device Size : %d%s\n", super.size, human_size((long long)super.size<<10));
			printf("   Raid Devices : %d\n", super.raid_disks);
			printf("  Total Devices : %d\n", super.nr_disks);
			printf("Preferred Minor : %d\n", super.md_minor);
			printf("\n");
			atime = super.utime;
			printf("    Update Time : %.24s\n", ctime(&atime));
			printf("          State : %s\n",
			       (super.state&(1<<MD_SB_CLEAN))?"clean":"dirty");
			printf(" Active Devices : %d\n", super.active_disks);
			printf("Working Devices : %d\n", super.working_disks);
			printf(" Failed Devices : %d\n", super.failed_disks);
			printf("  Spare Devices : %d\n", super.spare_disks);
			if (calc_sb_csum(&super) == super.sb_csum)
				printf("       Checksum : %x - correct\n", super.sb_csum);
			else
				printf("       Checksum : %x - expected %lx\n", super.sb_csum, calc_sb_csum(&super));
			if (SparcAdjust) {
				/* 2.2 sparc put the events in the wrong place
				 * So we copy the tail of the superblock
				 * up 4 bytes before continuing
				 */
				__u32 *sb32 = (__u32*)&super;
				memcpy(sb32+MD_SB_GENERIC_CONSTANT_WORDS+7,
				       sb32+MD_SB_GENERIC_CONSTANT_WORDS+7+1,
				       (MD_SB_WORDS - (MD_SB_GENERIC_CONSTANT_WORDS+7+1))*4);
				printf (" --- adjusting superblock for 2.2/sparc compatability ---\n");
			}
			printf("         Events : %d.%d\n", super.events_hi, super.events_lo);
			if (super.events_hi == super.cp_events_hi &&
			    super.events_lo == super.cp_events_lo &&
			    super.recovery_cp > 0 &&
			    (super.state & (1<<MD_SB_CLEAN)) == 0 )
				printf("Sync checkpoint : %d KB (%d%%)\n", super.recovery_cp/2, super.recovery_cp/(super.size/100*2));
			printf("\n");
			if (super.level == 5) {
				c = map_num(r5layout, super.layout);
				printf("         Layout : %s\n", c?c:"-unknown-");
			}
			if (super.level == 10)
				printf("         Layout : near=%d, far=%d\n",
				       super.layout&255, (super.layout>>8) & 255);

			switch(super.level) {
			case 0:
			case 4:
			case 5:
				printf("     Chunk Size : %dK\n", super.chunk_size/1024);
				break;
			case -1:
				printf("       Rounding : %dK\n", super.chunk_size/1024);
				break;
			default: break;		
			}
			printf("\n");
			printf("      Number   Major   Minor   RaidDevice State\n");
			for (d= -1; d<(signed int)(super.raid_disks+super.spare_disks); d++) {
				mdp_disk_t *dp;
				char *dv;
				char nb[5];
				if (d>=0) dp = &super.disks[d];
				else dp = &super.this_disk;
				sprintf(nb, "%4d", d);
				printf("%4s %5d   %5d    %5d    %5d     ", d < 0 ? "this" :  nb,
				       dp->number, dp->major, dp->minor, dp->raid_disk);
				if (dp->state & (1<<MD_DISK_FAULTY)) printf(" faulty");
				if (dp->state & (1<<MD_DISK_ACTIVE)) printf(" active");
				if (dp->state & (1<<MD_DISK_SYNC)) printf(" sync");
				if (dp->state & (1<<MD_DISK_REMOVED)) printf(" removed");
				if (dp->state == 0) { printf(" spare"); spares++; }
				if ((dv=map_dev(dp->major, dp->minor)))
					printf("   %s", dv);
				printf("\n");
				if (d == -1) printf("\n");
			}
		}
		if (SparcAdjust == 2) {
			printf(" ----- updating superblock on device ----\n");
			fd = open(devlist->devname, O_RDWR);
			if (fd < 0) {
				fprintf(stderr, Name ": cannot open %s to update superblock: %s\n",
					devlist->devname, strerror(errno));
				err = 1;
			} else {
				super.sb_csum = calc_sb_csum(&super);
				if (store_super(fd, &super)) {
					fprintf(stderr, Name ": Count not re-write superblock on %s\n",
						devlist->devname);
					err = 1;
				}
				close(fd);
			}
		}
	}
	if (brief) {
		struct array *ap;
		for (ap=arrays; ap; ap=ap->next) {
			char sep='=';
			char *c=map_num(pers, ap->super.level);
			char *d;
			printf("ARRAY %s level=%s num-devices=%d UUID=",
			       get_md_name(ap->super.md_minor),
			       c?c:"-unknown-", ap->super.raid_disks);
			if (spares) printf(" spares=%d", spares);
			if (ap->super.minor_version >= 90)
				printf("%08x:%08x:%08x:%08x", ap->super.set_uuid0, ap->super.set_uuid1,
				       ap->super.set_uuid2, ap->super.set_uuid3);
			else
				printf("%08x", ap->super.set_uuid0);
			printf("\n   devices");
			for (d=dl_next(ap->devs); d!= ap->devs; d=dl_next(d)) {
				printf("%c%s", sep, d);
				sep=',';
			}
			printf("\n");
		}
	}
	return rv;
}
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
9a9dab36	30	#include "mdadm.h"
cd29a5c8	31	#include "dlink.h"
64c4757e	32
82b27616 NB	33	#if ! defined(__BIG_ENDIAN) && ! defined(__LITTLE_ENDIAN)
	34	#error no endian defined
	35	#endif
64c4757e NB	36	#include "md_u.h"
64c4757e NB	37	#include "md_p.h"
bd526cee	38	int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust)
64c4757e NB	39	{
	40
	41	/* Read the raid superblock from a device and
	42	* display important content.
	43	*
	44	* If cannot be found, print reason: too small, bad magic
	45	*
	46	* Print:
	47	* version, ctime, level, size, raid+spare+
	48	* prefered minor
	49	* uuid
	50	*
	51	* utime, state etc
	52	*
9a9dab36	53	* If (brief) gather devices for same array and just print a mdadm.conf line including devices=
cd29a5c8	54	* if devlist==NULL, use conf_get_devs(
64c4757e	55	*/
cd29a5c8	56	int fd;
64c4757e NB	57	time_t atime;
	58	mdp_super_t super;
	59	int d;
682c7051	60	char *c;
cd29a5c8 NB	61	int rv = 0;
cd29a5c8 NB	62	int err;
feb716e9	63	int spares = 0;
64c4757e	64
cd29a5c8 NB	65	struct array {
	66	mdp_super_t super;
	67	void *devs;
	68	struct array *next;
	69	} *arrays = NULL;
	70
cd29a5c8 NB	71	for (; devlist ; devlist=devlist->next) {
	72	fd = open(devlist->devname, O_RDONLY);
	73	if (fd < 0) {
	74	if (!scan)
	75	fprintf(stderr,Name ": cannot open %s: %s\n",
	76	devlist->devname, strerror(errno));
	77	err = 1;
	78	}
	79	else {
	80	err = load_super(fd, &super);
	81	close(fd);
	82	}
	83	if (err && (brief\|\|scan))
	84	continue;
	85	if (err) rv =1;
	86	switch(err) {
	87	case 1:
	88	fprintf(stderr, Name ": cannot find device size for %s: %s\n",
	89	devlist->devname, strerror(errno));
	90	continue;
	91	case 2:
682c7051	92	/* fprintf(stderr, Name ": %s is too small for md: size is %ld sectors\n",
cd29a5c8	93	devlist->devname, size);
64c4757e	94	*/
cd29a5c8 NB	95	fprintf(stderr, Name ": %s is too small for md\n",
	96	devlist->devname);
	97	continue;
	98	case 3:
	99	fprintf(stderr, Name ": Cannot seek to superblock on %s: %s\n",
	100	devlist->devname, strerror(errno));
	101	continue;
	102	case 4:
	103	fprintf(stderr, Name ": Cannot read superblock on %s\n",
	104	devlist->devname);
	105	continue;
	106	case 5:
	107	fprintf(stderr, Name ": No super block found on %s (Expected magic %08x, got %08x)\n",
	108	devlist->devname, MD_SB_MAGIC, super.md_magic);
	109	continue;
	110	case 6:
	111	fprintf(stderr, Name ": Cannot interpret superblock on %s - version is %d\n",
	112	devlist->devname, super.major_version);
	113	continue;
	114	}
64c4757e	115
cd29a5c8 NB	116	/* Ok, its good enough to try, though the checksum could be wrong */
	117	if (brief) {
	118	struct array *ap;
	119	char *d;
	120	for (ap=arrays; ap; ap=ap->next) {
	121	if (compare_super(&ap->super, &super)==0)
	122	break;
	123	}
	124	if (!ap) {
	125	ap = malloc(sizeof(*ap));
	126	ap->super = super;
	127	ap->devs = dl_head();
	128	ap->next = arrays;
	129	arrays = ap;
	130	}
	131	d = dl_strdup(devlist->devname);
	132	dl_add(ap->devs, d);
	133	} else {
	134	printf("%s:\n",devlist->devname);
	135	printf(" Magic : %08x\n", super.md_magic);
	136	printf(" Version : %02d.%02d.%02d\n", super.major_version, super.minor_version,
	137	super.patch_version);
	138	if (super.minor_version >= 90)
	139	printf(" UUID : %08x:%08x:%08x:%08x\n", super.set_uuid0, super.set_uuid1,
	140	super.set_uuid2, super.set_uuid3);
	141	else
	142	printf(" UUID : %08x\n", super.set_uuid0);
64c4757e	143
cd29a5c8 NB	144	atime = super.ctime;
	145	printf(" Creation Time : %.24s\n", ctime(&atime));
	146	c=map_num(pers, super.level);
	147	printf(" Raid Level : %s\n", c?c:"-unknown-");
56eb10c0	148	printf(" Device Size : %d%s\n", super.size, human_size((long long)super.size<<10));
b83d95f3 NB	149	printf(" Raid Devices : %d\n", super.raid_disks);
b83d95f3 NB	150	printf(" Total Devices : %d\n", super.nr_disks);
cd29a5c8 NB	151	printf("Preferred Minor : %d\n", super.md_minor);
	152	printf("\n");
	153	atime = super.utime;
	154	printf(" Update Time : %.24s\n", ctime(&atime));
dd0781e5 NB	155	printf(" State : %s\n",
dd0781e5 NB	156	(super.state&(1<<MD_SB_CLEAN))?"clean":"dirty");
b83d95f3 NB	157	printf(" Active Devices : %d\n", super.active_disks);
	158	printf("Working Devices : %d\n", super.working_disks);
	159	printf(" Failed Devices : %d\n", super.failed_disks);
	160	printf(" Spare Devices : %d\n", super.spare_disks);
cd29a5c8 NB	161	if (calc_sb_csum(&super) == super.sb_csum)
	162	printf(" Checksum : %x - correct\n", super.sb_csum);
	163	else
98c6faba	164	printf(" Checksum : %x - expected %lx\n", super.sb_csum, calc_sb_csum(&super));
bd526cee NB	165	if (SparcAdjust) {
	166	/* 2.2 sparc put the events in the wrong place
	167	* So we copy the tail of the superblock
	168	* up 4 bytes before continuing
	169	*/
	170	__u32 sb32 = (__u32)&super;
	171	memcpy(sb32+MD_SB_GENERIC_CONSTANT_WORDS+7,
	172	sb32+MD_SB_GENERIC_CONSTANT_WORDS+7+1,
5787fa49	173	(MD_SB_WORDS - (MD_SB_GENERIC_CONSTANT_WORDS+7+1))*4);
bd526cee NB	174	printf (" --- adjusting superblock for 2.2/sparc compatability ---\n");
bd526cee NB	175	}
cd29a5c8	176	printf(" Events : %d.%d\n", super.events_hi, super.events_lo);
e5329c37 NB	177	if (super.events_hi == super.cp_events_hi &&
	178	super.events_lo == super.cp_events_lo &&
	179	super.recovery_cp > 0 &&
	180	(super.state & (1<<MD_SB_CLEAN)) == 0 )
	181	printf("Sync checkpoint : %d KB (%d%%)\n", super.recovery_cp/2, super.recovery_cp/(super.size/100*2));
cd29a5c8 NB	182	printf("\n");
	183	if (super.level == 5) {
	184	c = map_num(r5layout, super.layout);
	185	printf(" Layout : %s\n", c?c:"-unknown-");
	186	}
e5329c37 NB	187	if (super.level == 10)
	188	printf(" Layout : near=%d, far=%d\n",
	189	super.layout&255, (super.layout>>8) & 255);
	190
cd29a5c8 NB	191	switch(super.level) {
	192	case 0:
	193	case 4:
	194	case 5:
	195	printf(" Chunk Size : %dK\n", super.chunk_size/1024);
	196	break;
	197	case -1:
	198	printf(" Rounding : %dK\n", super.chunk_size/1024);
	199	break;
	200	default: break;
	201	}
	202	printf("\n");
b83d95f3	203	printf(" Number Major Minor RaidDevice State\n");
cd29a5c8 NB	204	for (d= -1; d<(signed int)(super.raid_disks+super.spare_disks); d++) {
	205	mdp_disk_t *dp;
	206	char *dv;
	207	char nb[5];
	208	if (d>=0) dp = &super.disks[d];
	209	else dp = &super.this_disk;
	210	sprintf(nb, "%4d", d);
	211	printf("%4s %5d %5d %5d %5d ", d < 0 ? "this" : nb,
	212	dp->number, dp->major, dp->minor, dp->raid_disk);
	213	if (dp->state & (1<<MD_DISK_FAULTY)) printf(" faulty");
	214	if (dp->state & (1<<MD_DISK_ACTIVE)) printf(" active");
	215	if (dp->state & (1<<MD_DISK_SYNC)) printf(" sync");
	216	if (dp->state & (1<<MD_DISK_REMOVED)) printf(" removed");
feb716e9	217	if (dp->state == 0) { printf(" spare"); spares++; }
cd29a5c8 NB	218	if ((dv=map_dev(dp->major, dp->minor)))
	219	printf(" %s", dv);
	220	printf("\n");
e5329c37	221	if (d == -1) printf("\n");
cd29a5c8 NB	222	}
cd29a5c8 NB	223	}
bd526cee NB	224	if (SparcAdjust == 2) {
	225	printf(" ----- updating superblock on device ----\n");
	226	fd = open(devlist->devname, O_RDWR);
	227	if (fd < 0) {
	228	fprintf(stderr, Name ": cannot open %s to update superblock: %s\n",
	229	devlist->devname, strerror(errno));
	230	err = 1;
	231	} else {
	232	super.sb_csum = calc_sb_csum(&super);
	233	if (store_super(fd, &super)) {
	234	fprintf(stderr, Name ": Count not re-write superblock on %s\n",
	235	devlist->devname);
	236	err = 1;
	237	}
	238	close(fd);
	239	}
	240	}
82b27616	241	}
cd29a5c8 NB	242	if (brief) {
	243	struct array *ap;
	244	for (ap=arrays; ap; ap=ap->next) {
	245	char sep='=';
	246	char *c=map_num(pers, ap->super.level);
	247	char *d;
dd0781e5 NB	248	printf("ARRAY %s level=%s num-devices=%d UUID=",
	249	get_md_name(ap->super.md_minor),
	250	c?c:"-unknown-", ap->super.raid_disks);
feb716e9	251	if (spares) printf(" spares=%d", spares);
cd29a5c8 NB	252	if (ap->super.minor_version >= 90)
	253	printf("%08x:%08x:%08x:%08x", ap->super.set_uuid0, ap->super.set_uuid1,
	254	ap->super.set_uuid2, ap->super.set_uuid3);
	255	else
	256	printf("%08x", ap->super.set_uuid0);
	257	printf("\n devices");
	258	for (d=dl_next(ap->devs); d!= ap->devs; d=dl_next(d)) {
	259	printf("%c%s", sep, d);
	260	sep=',';
	261	}
	262	printf("\n");
	263	}
64c4757e	264	}
cd29a5c8	265	return rv;
64c4757e	266	}