xref: /src/usr.sbin/bad144/bad144.c

/*	$NetBSD: bad144.c,v 1.29 2011/11/25 13:13:33 joerg Exp $	*/

/*
 * Copyright (c) 1980, 1986, 1988, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include <sys/cdefs.h>
#ifndef lint
__COPYRIGHT("@(#) Copyright (c) 1980, 1986, 1988, 1993\
 The Regents of the University of California.  All rights reserved.");
#endif /* not lint */

#ifndef lint
#if 0
static char sccsid[] = "@(#)bad144.c	8.2 (Berkeley) 4/27/95";
#else
__RCSID("$NetBSD: bad144.c,v 1.29 2011/11/25 13:13:33 joerg Exp $");
#endif
#endif /* not lint */

/*
 * bad144
 *
 * This program prints and/or initializes a bad block record for a pack,
 * in the format used by the DEC standard 144.
 * It can also add bad sector(s) to the record, moving the sector
 * replacements as necessary.
 *
 * It is preferable to write the bad information with a standard formatter,
 * but this program will do.
 *
 * RP06 sectors are marked as bad by inverting the format bit in the
 * header; on other drives the valid-sector bit is cleared.
 */
#include <sys/param.h>
#include <sys/dkbad.h>
#include <sys/ioctl.h>
#include <sys/file.h>
#include <sys/disklabel.h>
#include <ufs/ufs/dinode.h>
#include <ufs/ffs/fs.h>

#include <err.h>
#include <paths.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <util.h>

#define RETRIES	10		/* number of retries on reading old sectors */

#ifdef __vax__
static int	fflag;
#endif
static int	add, copy, verbose, nflag;
static int	dups;
static int	badfile = -1;		/* copy of badsector table to use, -1 if any */
#define MAXSECSIZE	1024
static struct	dkbad curbad, oldbad;
#define	DKBAD_MAGIC	0x4321

static daddr_t	size;
static struct	disklabel *dp;
static struct	disklabel label;
static char	diskname[MAXPATHLEN];

static daddr_t	badsn(const struct bt_bad *);
static int	blkcopy(int, daddr_t, daddr_t);
static void	blkzero(int, daddr_t);
static int	checkold(void);
static int	compare(const void *, const void *);
static daddr_t	getold(int, struct dkbad *);
static void	shift(int, int, int);
__dead static void	usage(void);

#ifdef __vax__
#define OPTSTRING "01234acfvn"
#else
#define OPTSTRING "01234acvn"
#endif

int
main(int argc, char *argv[])
{
	struct bt_bad *bt;
	daddr_t	sn, bn[NBT_BAD];
	int i, f, nbad, new, bad, errs, ch;

	while ((ch = getopt(argc, argv, OPTSTRING)) != -1) {
		switch (ch) {
		case '0':
		case '1':
		case '2':
		case '3':
		case '4':
			badfile = ch - '0';
			break;
		case 'a':
			add = 1;
			break;
		case 'c':
			copy = 1;
			break;
#ifdef __vax__
		case 'f':
			fflag = 1;
			break;
#endif
		case 'n':
			nflag = 1;
			/* FALLTHROUGH */
		case 'v':
			verbose = 1;
			break;
		case '?':
		default:
			usage();
		}
	}

	argc -= optind;
	argv += optind;

	if (argc < 1) {
		usage();
	}
	f = opendisk(argv[0], argc == 1 ? O_RDONLY : O_RDWR, diskname,
	    sizeof(diskname), 0);
	if (f < 0)
		err(4, "opendisk `%s'", diskname);
	/* obtain label and adjust to fit */
	dp = &label;
	if (ioctl(f, DIOCGDINFO, dp) < 0)
		err(4, "ioctl DIOCGDINFO `%s'", diskname);
	if (dp->d_magic != DISKMAGIC || dp->d_magic2 != DISKMAGIC
		/* dkcksum(lp) != 0 */ )
		errx(1, "Bad pack magic number (pack is unlabeled)");
	if (dp->d_secsize > MAXSECSIZE || dp->d_secsize == 0)
		errx(7, "Disk sector size too large/small (%d)",
		    dp->d_secsize);
#ifdef __i386__
	if (dp->d_type == DTYPE_SCSI)
		errx(1, "SCSI disks don't use bad144!");
	/* are we inside a DOS partition? */
	if (dp->d_partitions[0].p_offset) {
		/* yes, rules change. assume bad tables at end of partition C,
		   which maps all of DOS partition we are within -wfj */
		size = dp->d_partitions[2].p_offset + dp->d_partitions[2].p_size;
	}
#endif
	size = dp->d_nsectors * dp->d_ntracks * dp->d_ncylinders;
	argc--;
	argv++;
	if (argc == 0) {
		sn = getold(f, &oldbad);
		printf("bad block information at sector %lld in %s:\n",
		    (long long)sn, diskname);
		printf("cartridge serial number: %d(10)\n", oldbad.bt_csn);
		switch (oldbad.bt_flag) {

		case (u_short)-1:
			printf("alignment cartridge\n");
			break;

		case DKBAD_MAGIC:
			break;

		default:
			printf("bt_flag=%x(16)?\n", oldbad.bt_flag);
			break;
		}
		bt = oldbad.bt_bad;
		for (i = 0; i < NBT_BAD; i++) {
			bad = (bt->bt_cyl<<16) + bt->bt_trksec;
			if (bad < 0)
				break;
			printf("sn=%lld, cn=%d, tn=%d, sn=%d\n",
			    (long long)badsn(bt),
			    bt->bt_cyl, bt->bt_trksec>>8, bt->bt_trksec&0xff);
			bt++;
		}
		(void) checkold();
		exit(0);
	}
	if (add) {
		/*
		 * Read in the old badsector table.
		 * Verify that it makes sense, and the bad sectors
		 * are in order.  Copy the old table to the new one.
		 */
		(void) getold(f, &oldbad);
		i = checkold();
		if (verbose)
			printf("Had %d bad sectors, adding %d\n", i, argc);
		if (i + argc > NBT_BAD) {
			printf("bad144: not enough room for %d more sectors\n",
				argc);
			printf("limited to %d by information format\n",
			    NBT_BAD);
			exit(1);
		}
		curbad = oldbad;
	} else {
		curbad.bt_csn = atoi(*argv++);
		argc--;
		curbad.bt_mbz = 0;
		curbad.bt_flag = DKBAD_MAGIC;
		if (argc > NBT_BAD) {
			printf("bad144: too many bad sectors specified\n");
			printf("limited to %d by information format\n",
			    NBT_BAD);
			exit(1);
		}
		i = 0;
	}
	errs = 0;
	new = argc;
	while (argc > 0) {
		sn = atoi(*argv++);
		argc--;
		if (sn < 0 || sn >= size) {
			printf("%lld: out of range [0,%lld) for disk %s\n",
			    (long long)sn, (long long)size, dp->d_typename);
			errs++;
			continue;
		}
		bn[i] = sn;
		curbad.bt_bad[i].bt_cyl = sn / (dp->d_nsectors*dp->d_ntracks);
		sn %= (dp->d_nsectors*dp->d_ntracks);
		curbad.bt_bad[i].bt_trksec =
		    ((sn/dp->d_nsectors) << 8) + (sn%dp->d_nsectors);
		i++;
	}
	if (errs)
		exit(1);
	nbad = i;
	while (i < NBT_BAD) {
		curbad.bt_bad[i].bt_trksec = -1;
		curbad.bt_bad[i].bt_cyl = -1;
		i++;
	}
	if (add) {
		/*
		 * Sort the new bad sectors into the list.
		 * Then shuffle the replacement sectors so that
		 * the previous bad sectors get the same replacement data.
		 */
		qsort((char *)curbad.bt_bad, nbad, sizeof (struct bt_bad),
		    compare);
		if (dups)
			errx(3, "bad sectors have been duplicated; "
			    "can't add existing sectors");
		shift(f, nbad, nbad-new);
	}
	if (badfile == -1)
		i = 0;
	else
		i = badfile * 2;
	for (; i < 10 && i < (int)dp->d_nsectors; i += 2) {
		if (lseek(f,
		    (off_t)(dp->d_secsize * (size - dp->d_nsectors + i)),
		    SEEK_SET) < 0)
			err(4, "lseek");
		if (verbose)
			printf("write badsect file at %lld\n",
				(long long)size - dp->d_nsectors + i);
		if (nflag == 0 && write(f, (caddr_t)&curbad, sizeof(curbad)) !=
		    sizeof(curbad))
			err(4, "write bad sector file %d", i/2);
		if (badfile != -1)
			break;
	}
#ifdef __vax__
	if (nflag == 0 && fflag)
		for (i = nbad - new; i < nbad; i++)
			format(f, bn[i]);
#endif
#ifdef DIOCSBAD
	if (nflag == 0 && ioctl(f, DIOCSBAD, (caddr_t)&curbad) < 0)
		warnx("Can't sync bad-sector file; reboot for changes "
		    "to take effect");
#endif
	if ((dp->d_flags & D_BADSECT) == 0 && nflag == 0) {
		dp->d_flags |= D_BADSECT;
		if (ioctl(f, DIOCWDINFO, dp) < 0) {
			warn("label");
			errx(1,
			    "Can't write label to enable bad sector handling");
		}
	}
	return (0);
}

static daddr_t
getold(int f, struct dkbad *bad)
{
	int i;
	daddr_t sn;

	if (badfile == -1)
		i = 0;
	else
		i = badfile * 2;
	for (; i < 10 && i < (int)dp->d_nsectors; i += 2) {
		sn = size - dp->d_nsectors + i;
		if (lseek(f, (off_t)(sn * dp->d_secsize), SEEK_SET) < 0)
			err(4, "lseek");
		if ((size_t)read(f, (char *) bad, dp->d_secsize) == dp->d_secsize) {
			if (i > 0)
				printf("Using bad-sector file %d\n", i/2);
			return(sn);
		}
		warn("read bad sector file at sn %lld", (long long)sn);
		if (badfile != -1)
			break;
	}
	errx(1, "%s: can't read bad block info", diskname);
	/*NOTREACHED*/
}

static int
checkold(void)
{
	int i;
	struct bt_bad *bt;
	daddr_t sn, lsn;
	int errors = 0, warned = 0;

	lsn = 0;
	if (oldbad.bt_flag != DKBAD_MAGIC) {
		warnx("%s: bad flag in bad-sector table", diskname);
		errors++;
	}
	if (oldbad.bt_mbz != 0) {
		warnx("%s: bad magic number", diskname);
		errors++;
	}
	bt = oldbad.bt_bad;
	for (i = 0; i < NBT_BAD; i++, bt++) {
		if (bt->bt_cyl == 0xffff && bt->bt_trksec == 0xffff)
			break;
		if ((bt->bt_cyl >= dp->d_ncylinders) ||
		    ((bt->bt_trksec >> 8) >= dp->d_ntracks) ||
		    ((bt->bt_trksec & 0xff) >= dp->d_nsectors)) {
			warnx("cyl/trk/sect out of range in existing entry: "
			    "sn=%lld, cn=%d, tn=%d, sn=%d",
			    (long long)badsn(bt), bt->bt_cyl, bt->bt_trksec>>8,
			    bt->bt_trksec & 0xff);
			errors++;
		}
		sn = (bt->bt_cyl * dp->d_ntracks +
		    (bt->bt_trksec >> 8)) *
		    dp->d_nsectors + (bt->bt_trksec & 0xff);
		if (i > 0 && sn < lsn && !warned) {
		    warnx("bad sector file is out of order");
		    errors++;
		    warned++;
		}
		if (i > 0 && sn == lsn) {
		    warnx("bad sector file contains duplicates (sn %lld)",
			(long long)sn);
		    errors++;
		}
		lsn = sn;
	}
	if (errors)
		exit(1);
	return (i);
}

/*
 * Move the bad sector replacements
 * to make room for the new bad sectors.
 * new is the new number of bad sectors, old is the previous count.
 */
static void
shift(int f, int new, int old)
{
	daddr_t repl;

	/*
	 * First replacement is last sector of second-to-last track.
	 */
	repl = size - dp->d_nsectors - 1;
	new--; old--;
	while (new >= 0 && new != old) {
		if (old < 0 ||
		    compare(&curbad.bt_bad[new], &oldbad.bt_bad[old]) > 0) {
			/*
			 * Insert new replacement here-- copy original
			 * sector if requested and possible,
			 * otherwise write a zero block.
			 */
			if (!copy ||
			    !blkcopy(f, badsn(&curbad.bt_bad[new]), repl - new))
				blkzero(f, repl - new);
		} else {
			if (blkcopy(f, repl - old, repl - new) == 0)
			    warnx("Can't copy replacement sector %lld to %lld",
				(long long)repl-old, (long long)repl-new);
			old--;
		}
		new--;
	}
}

static char *buf;

/*
 *  Copy disk sector s1 to s2.
 */
static int
blkcopy(int f, daddr_t s1, daddr_t s2)
{
	int tries, n;

	if (buf == NULL) {
		buf = malloc((unsigned)dp->d_secsize);
		if (buf == NULL)
			errx(20, "Out of memory");
	}
	for (tries = 0; tries < RETRIES; tries++) {
		if (lseek(f, (off_t)(dp->d_secsize * s1), SEEK_SET) < 0)
			err(4, "lseek");
		if ((size_t)(n = read(f, buf, dp->d_secsize)) == dp->d_secsize)
			break;
	}
	if ((size_t)n != dp->d_secsize) {
		if (n < 0)
			err(4, "can't read sector, %lld", (long long)s1);
		else
			errx(4, "can't read sector, %lld", (long long)s1);
		return(0);
	}
	if (lseek(f, (off_t)(dp->d_secsize * s2), SEEK_SET) < 0)
		err(4, "lseek");
	if (verbose)
		printf("copying %lld to %lld\n", (long long)s1, (long long)s2);
	if (nflag == 0 && (size_t)write(f, buf, dp->d_secsize) != dp->d_secsize) {
		warn("can't write replacement sector, %lld", (long long)s2);
		return(0);
	}
	return(1);
}

static void
blkzero(int f, daddr_t sn)
{
	char *zbuf;

	zbuf = calloc(1, (unsigned int)dp->d_secsize);
	if (zbuf == NULL)
		errx(20, "Out of memory");
	if (lseek(f, (off_t)(dp->d_secsize * sn), SEEK_SET) < 0) {
		free(zbuf);
		err(4, "lseek");
	}
	if (verbose)
		printf("zeroing %lld\n", (long long)sn);
	if (nflag == 0 && (size_t)write(f, zbuf, dp->d_secsize) != dp->d_secsize)
		warn("can't write replacement sector, %lld",
		    (long long)sn);
	free(zbuf);
}

static int
compare(const void *v1, const void *v2)
{
	const struct bt_bad *b1 = v1;
	const struct bt_bad *b2 = v2;

	if (b1->bt_cyl > b2->bt_cyl)
		return(1);
	if (b1->bt_cyl < b2->bt_cyl)
		return(-1);
	if (b1->bt_trksec == b2->bt_trksec)
		dups++;
	return (b1->bt_trksec - b2->bt_trksec);
}

static daddr_t
badsn(const struct bt_bad *bt)
{

	return ((bt->bt_cyl * dp->d_ntracks
		+ (bt->bt_trksec >> 8)) * dp->d_nsectors
		+ (bt->bt_trksec & 0xff));
}

#ifdef __vax__

struct rp06hdr {
	short	h_cyl;
	short	h_trksec;
	short	h_key1;
	short	h_key2;
	char	h_data[512];
#define	RP06_FMT	010000		/* 1 == 16 bit, 0 == 18 bit */
};

/*
 * Most massbus and unibus drives
 * have headers of this form
 */
struct hpuphdr {
	u_short	hpup_cyl;
	u_char	hpup_sect;
	u_char	hpup_track;
	char	hpup_data[512];
#define	HPUP_OKSECT	0xc000		/* this normally means sector is good */
#define	HPUP_16BIT	0x1000		/* 1 == 16 bit format */
};

static int rp06format(struct formats *, struct disklabel *, daddr_t, char *, int);
static int hpupformat(struct formats *, struct disklabel *, daddr_t, char *, int);

static struct	formats {
	char	*f_name;		/* disk name */
	int	f_bufsize;		/* size of sector + header */
	int	f_bic;			/* value to bic in hpup_cyl */
	int	(*f_routine)();		/* routine for special handling */
} formats[] = {
	{ "rp06",	sizeof (struct rp06hdr), RP06_FMT,	rp06format },
	{ "eagle",	sizeof (struct hpuphdr), HPUP_OKSECT,	hpupformat },
	{ "capricorn",	sizeof (struct hpuphdr), HPUP_OKSECT,	hpupformat },
	{ "rm03",	sizeof (struct hpuphdr), HPUP_OKSECT,	hpupformat },
	{ "rm05",	sizeof (struct hpuphdr), HPUP_OKSECT,	hpupformat },
	{ "9300",	sizeof (struct hpuphdr), HPUP_OKSECT,	hpupformat },
	{ "9766",	sizeof (struct hpuphdr), HPUP_OKSECT,	hpupformat },
	{ 0, 0, 0, 0 }
};

/*ARGSUSED*/
static int
hpupformat(struct formats *fp, struct disklabel *dp, daddr_t blk, char *buf,
	   int count)
{
	struct hpuphdr *hdr = (struct hpuphdr *)buf;
	int sect;

	if (count < sizeof(struct hpuphdr)) {
		hdr->hpup_cyl = (HPUP_OKSECT | HPUP_16BIT) |
			(blk / (dp->d_nsectors * dp->d_ntracks));
		sect = blk % (dp->d_nsectors * dp->d_ntracks);
		hdr->hpup_track = (u_char)(sect / dp->d_nsectors);
		hdr->hpup_sect = (u_char)(sect % dp->d_nsectors);
	}
	return (0);
}

/*ARGSUSED*/
static int
rp06format(struct formats *fp, struct disklabel *dp, daddr_t blk, char *buf,
	   int count)
{

	if (count < sizeof(struct rp06hdr)) {
		warnx("Can't read header on blk %d, can't reformat", blk);
		return (-1);
	}
	return (0);
}

static void
format(int fd, daddr_t blk)
{
	struct formats *fp;
	static char *buf;
	static char bufsize;
	struct format_op fop;
	int n;

	for (fp = formats; fp->f_name; fp++)
		if (strcmp(dp->d_typename, fp->f_name) == 0)
			break;
	if (fp->f_name == 0)
		errx(2, "don't know how to format %s disks", dp->d_typename);
	if (buf && bufsize < fp->f_bufsize) {
		free(buf);
		buf = NULL;
	}
	if (buf == NULL)
		buf = malloc((unsigned)fp->f_bufsize);
	if (buf == NULL)
		errx(3, "can't allocate sector buffer");
	bufsize = fp->f_bufsize;
	/*
	 * Here we do the actual formatting.  All we really
	 * do is rewrite the sector header and flag the bad sector
	 * according to the format table description.  If a special
	 * purpose format routine is specified, we allow it to
	 * process the sector as well.
	 */
	if (verbose)
		printf("format blk %d\n", blk);
	memset((char *)&fop, 0, sizeof(fop));
	fop.df_buf = buf;
	fop.df_count = fp->f_bufsize;
	fop.df_startblk = blk;
	memset(buf, 0, fp->f_bufsize);
	if (ioctl(fd, DIOCRFORMAT, &fop) < 0)
		warn("read format");
	if (fp->f_routine &&
	    (*fp->f_routine)(fp, dp, blk, buf, fop.df_count) != 0)
		return;
	if (fp->f_bic) {
		struct hpuphdr *xp = (struct hpuphdr *)buf;

		xp->hpup_cyl &= ~fp->f_bic;
	}
	if (nflag)
		return;
	memset((char *)&fop, 0, sizeof(fop));
	fop.df_buf = buf;
	fop.df_count = fp->f_bufsize;
	fop.df_startblk = blk;
	if (ioctl(fd, DIOCWFORMAT, &fop) < 0)
		err(4, "write format");
	if (fop.df_count != fp->f_bufsize)
		warn("write format %d", blk);
}
#endif

static void
usage(void)
{

	fprintf(stderr, "usage: bad144 [-%sv] disk [sno [bad ...]]\n"
	    "to read or overwrite the bad-sector table, e.g.: bad144 hp0\n"
	    "or bad144 -a [-c%sv] disk [bad ...]\n"
	    "where options are:\n"
	    "\t-a  add new bad sectors to the table\n"
	    "\t-c  copy original sector to replacement\n"
	    "%s"
	    "\t-v  verbose mode\n",
#ifdef __vax__
	    "f", "f", "\t-f  reformat listed sectors as bad\n"
#else
	    "", "", ""
#endif
	    );
	exit(1);
}