xref: /netbsd-src/sys/dev/sun/disksubr.c (revision 76c7fc5f6b13ed0b1508e6b313e88e59977ed78e)
1 /*	$NetBSD: disksubr.c,v 1.16 2019/04/03 22:10:52 christos Exp $ */
2 
3 /*
4  * Copyright (c) 1982, 1986, 1988 Regents of the University of California.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 /*
32  * Copyright (c) 1994, 1995 Gordon W. Ross
33  * Copyright (c) 1994 Theo de Raadt
34  * All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55  */
56 
57 #include <sys/cdefs.h>
58 __KERNEL_RCSID(0, "$NetBSD: disksubr.c,v 1.16 2019/04/03 22:10:52 christos Exp $");
59 
60 #include <sys/param.h>
61 #include <sys/systm.h>
62 #include <sys/buf.h>
63 #include <sys/ioccom.h>
64 #include <sys/device.h>
65 #include <sys/disklabel.h>
66 #include <sys/disk.h>
67 #include <sys/dkbad.h>
68 
69 #include <dev/sun/disklabel.h>
70 
71 #if LABELSECTOR != 0
72 #error  "Default value of LABELSECTOR no longer zero?"
73 #endif
74 
75 static	const char *disklabel_sun_to_bsd(char *, struct disklabel *);
76 static	int disklabel_bsd_to_sun(struct disklabel *, char *);
77 
78 /*
79  * Attempt to read a disk label from a device
80  * using the indicated strategy routine.
81  * The label must be partly set up before this:
82  * secpercyl, secsize and anything required for a block i/o read
83  * operation in the driver's strategy/start routines
84  * must be filled in before calling us.
85  *
86  * Return buffer for use in signalling errors if requested.
87  *
88  * Returns null on success and an error string on failure.
89  */
90 const char *
91 readdisklabel(dev_t dev, void (*strat)(struct buf *), struct disklabel *lp, struct cpu_disklabel *clp)
92 {
93 	struct buf *bp;
94 	struct disklabel *dlp;
95 	struct sun_disklabel *slp;
96 	int error;
97 
98 	/* minimal requirements for archtypal disk label */
99 	if (lp->d_secperunit == 0)
100 		lp->d_secperunit = 0x1fffffff;
101 	if (lp->d_npartitions == 0) {
102 		lp->d_npartitions = RAW_PART + 1;
103 		if (lp->d_partitions[RAW_PART].p_size == 0)
104 			lp->d_partitions[RAW_PART].p_size = 0x1fffffff;
105 		lp->d_partitions[RAW_PART].p_offset = 0;
106 	}
107 
108 	/* obtain buffer to probe drive with */
109 	bp = geteblk((int)lp->d_secsize);
110 
111 	/* next, dig out disk label */
112 	bp->b_dev = dev;
113 	bp->b_blkno = LABELSECTOR;
114 	bp->b_cylinder = 0;
115 	bp->b_bcount = lp->d_secsize;
116 	bp->b_flags |= B_READ;
117 	(*strat)(bp);
118 
119 	/* if successful, locate disk label within block and validate */
120 	error = biowait(bp);
121 	if (error == 0) {
122 		/* Save the whole block in case it has info we need. */
123 		memcpy(clp->cd_block, bp->b_data, sizeof(clp->cd_block));
124 	}
125 	brelse(bp, 0);
126 	if (error)
127 		return ("disk label read error");
128 
129 	/* Check for a NetBSD disk label at LABELOFFSET */
130 	dlp = (struct disklabel *) (clp->cd_block + LABELOFFSET);
131 	if (dlp->d_magic == DISKMAGIC) {
132 		if (dkcksum(dlp))
133 			return ("NetBSD disk label corrupted");
134 		*lp = *dlp;
135 		return (NULL);
136 	}
137 
138 	/* Check for a Sun disk label (for PROM compatibility). */
139 	slp = (struct sun_disklabel *) clp->cd_block;
140 	if (slp->sl_magic == SUN_DKMAGIC)
141 		return (disklabel_sun_to_bsd(clp->cd_block, lp));
142 
143 	/*
144 	 * Check for a NetBSD disk label somewhere in LABELSECTOR
145 	 * (compat with others big-endian boxes)
146 	 */
147 	for (dlp = (struct disklabel *)clp->cd_block;
148 	    dlp <= (struct disklabel *)((char *)clp->cd_block +
149 	    DEV_BSIZE - sizeof(*dlp));
150 	    dlp = (struct disklabel *)((char *)dlp + sizeof(long))) {
151 		if (dlp->d_magic != DISKMAGIC || dlp->d_magic2 != DISKMAGIC) {
152 			continue;
153 		}
154 		if (dlp->d_npartitions > MAXPARTITIONS || dkcksum(dlp) != 0)
155 			return("NetBSD disk label corrupted");
156 		else {
157 			*lp = *dlp;
158 			return(NULL);
159 		}
160 	}
161 
162 	memset(clp->cd_block, 0, sizeof(clp->cd_block));
163 	return NULL;
164 }
165 
166 /*
167  * Write disk label back to device after modification.
168  * Current label is already in clp->cd_block[]
169  */
170 int
171 writedisklabel(dev_t dev, void (*strat)(struct buf *), struct disklabel *lp, struct cpu_disklabel *clp)
172 {
173 	struct buf *bp;
174 	int error;
175 	struct disklabel *dlp;
176 	struct sun_disklabel *slp;
177 
178 	/*
179 	 * Embed native label in a piece of wasteland.
180 	 */
181 	if (sizeof(struct disklabel) > sizeof slp->sl_bsdlabel)
182 		return EFBIG;
183 
184 	slp = (struct sun_disklabel *)clp->cd_block;
185 	memset(slp->sl_bsdlabel, 0, sizeof(slp->sl_bsdlabel));
186 	dlp = (struct disklabel *)slp->sl_bsdlabel;
187 	*dlp = *lp;
188 
189 	/* Build a SunOS compatible label around the native label */
190 	error = disklabel_bsd_to_sun(lp, clp->cd_block);
191 	if (error)
192 		return (error);
193 
194 	/* Get a buffer and copy the new label into it. */
195 	bp = geteblk((int)lp->d_secsize);
196 	memcpy(bp->b_data, clp->cd_block, sizeof(clp->cd_block));
197 
198 	/* Write out the updated label. */
199 	bp->b_dev = dev;
200 	bp->b_blkno = LABELSECTOR;
201 	bp->b_cylinder = 0;
202 	bp->b_bcount = lp->d_secsize;
203 	bp->b_flags |= B_WRITE;
204 	(*strat)(bp);
205 	error = biowait(bp);
206 	brelse(bp, 0);
207 
208 	return (error);
209 }
210 
211 /************************************************************************
212  *
213  * The rest of this was taken from arch/sparc/scsi/sun_disklabel.c
214  * and then substantially rewritten by Gordon W. Ross
215  *
216  ************************************************************************/
217 
218 /* What partition types to assume for Sun disklabels: */
219 static u_char
220 sun_fstypes[8] = {
221 	FS_BSDFFS,	/* a */
222 	FS_SWAP,	/* b */
223 	FS_OTHER,	/* c - whole disk */
224 	FS_BSDFFS,	/* d */
225 	FS_BSDFFS,	/* e */
226 	FS_BSDFFS,	/* f */
227 	FS_BSDFFS,	/* g */
228 	FS_BSDFFS,	/* h */
229 };
230 
231 /*
232  * Given a SunOS disk label, set lp to a BSD disk label.
233  * Returns NULL on success, else an error string.
234  *
235  * The BSD label is cleared out before this is called.
236  */
237 static const char *
238 disklabel_sun_to_bsd(char *cp, struct disklabel *lp)
239 {
240 	struct sun_disklabel *sl;
241 	struct partition *npp;
242 	struct sun_dkpart *spp;
243 	int i, secpercyl;
244 	unsigned int secpblck;
245 	u_short cksum, *sp1, *sp2;
246 
247 	sl = (struct sun_disklabel *)cp;
248 
249 	/* Verify the XOR check. */
250 	sp1 = (u_short *)sl;
251 	sp2 = (u_short *)(sl + 1);
252 	cksum = 0;
253 	while (sp1 < sp2)
254 		cksum ^= *sp1++;
255 	if (cksum != 0)
256 		return("SunOS disk label, bad checksum");
257 
258 	/* Format conversion. */
259 	lp->d_magic = DISKMAGIC;
260 	lp->d_magic2 = DISKMAGIC;
261 	memcpy(lp->d_packname, sl->sl_text, sizeof(lp->d_packname));
262 
263 	secpblck = lp->d_secsize / 512;
264 	if (secpblck == 0) secpblck = 1; /* can't happen */
265 	lp->d_secsize = 512;
266 	lp->d_nsectors   = sl->sl_nsectors;
267 	lp->d_ntracks    = sl->sl_ntracks;
268 	lp->d_ncylinders = sl->sl_ncylinders;
269 
270 	secpercyl = sl->sl_nsectors * sl->sl_ntracks;
271 	lp->d_secpercyl  = secpercyl;
272 	lp->d_secperunit = secpercyl * sl->sl_ncylinders;
273 
274 	lp->d_sparespercyl = sl->sl_sparespercyl;
275 	lp->d_acylinders   = sl->sl_acylinders;
276 	lp->d_rpm          = sl->sl_rpm;
277 	lp->d_interleave   = sl->sl_interleave;
278 
279 	lp->d_npartitions = 8;
280 	/* These are as defined in <ufs/ffs/fs.h> */
281 	lp->d_bbsize = 8192;	/* XXX */
282 	lp->d_sbsize = 8192;	/* XXX */
283 
284 	for (i = 0; i < 8; i++) {
285 		spp = &sl->sl_part[i];
286 		npp = &lp->d_partitions[i];
287 
288 		if (npp->p_fstype == FS_ISO9660
289 		    && spp->sdkp_cyloffset * secpercyl == npp->p_offset*secpblck
290 		    && spp->sdkp_nsectors <= npp->p_size*secpblck
291 		    && npp->p_size > 0 && spp->sdkp_nsectors > 0) {
292 			/*
293 			 * This happens for example on sunlabel'd hybrid
294 			 * (ffs + ISO9660) CDs, like our install CDs.
295 			 * The cd driver has initialized a valid ISO9660
296 			 * partition (including session parameters), so
297 			 * we better not overwrite it.
298 			 */
299 			npp->p_offset *= secpblck;
300 			npp->p_size = spp->sdkp_nsectors;
301 			npp->p_cdsession *= secpblck;
302 			continue;
303 		}
304 		npp->p_offset = spp->sdkp_cyloffset * secpercyl;
305 		npp->p_size = spp->sdkp_nsectors;
306 		if (npp->p_size == 0) {
307 			npp->p_fstype = FS_UNUSED;
308 		} else {
309 			npp->p_fstype = sun_fstypes[i];
310 			if (npp->p_fstype == FS_BSDFFS) {
311 				/*
312 				 * The sun label does not store the FFS fields,
313 				 * so just set them with default values here.
314 				 */
315 				npp->p_fsize = 1024;
316 				npp->p_frag = 8;
317 				npp->p_cpg = 16;
318 			}
319 		}
320 	}
321 
322 	lp->d_checksum = 0;
323 	lp->d_checksum = dkcksum(lp);
324 	return (NULL);
325 }
326 
327 /*
328  * Given a BSD disk label, update the Sun disklabel
329  * pointed to by cp with the new info.  Note that the
330  * Sun disklabel may have other info we need to keep.
331  * Returns zero or error code.
332  */
333 static int
334 disklabel_bsd_to_sun(struct disklabel *lp, char *cp)
335 {
336 	struct sun_disklabel *sl;
337 	struct partition *npp;
338 	struct sun_dkpart *spp;
339 	int i, secpercyl;
340 	u_short cksum, *sp1, *sp2;
341 
342 	if (lp->d_secsize != 512)
343 		return (EINVAL);
344 
345 	sl = (struct sun_disklabel *)cp;
346 
347 	/*
348 	 * Format conversion.
349 	 */
350 	memcpy(sl->sl_text, lp->d_packname, sizeof(lp->d_packname));
351 	sl->sl_rpm = lp->d_rpm;
352 	sl->sl_pcylinders   = lp->d_ncylinders + lp->d_acylinders; /* XXX */
353 	sl->sl_sparespercyl = lp->d_sparespercyl;
354 	sl->sl_interleave   = lp->d_interleave;
355 	sl->sl_ncylinders   = lp->d_ncylinders;
356 	sl->sl_acylinders   = lp->d_acylinders;
357 	sl->sl_ntracks      = lp->d_ntracks;
358 	sl->sl_nsectors     = lp->d_nsectors;
359 
360 	secpercyl = sl->sl_nsectors * sl->sl_ntracks;
361 	for (i = 0; i < 8; i++) {
362 		spp = &sl->sl_part[i];
363 		npp = &lp->d_partitions[i];
364 
365 		/*
366 		 * SunOS partitions must start on a cylinder boundary.
367 		 * Note this restriction is forced upon NetBSD/sparc
368 		 * labels too, since we want to keep both labels
369 		 * synchronised.
370 		 */
371 		if (npp->p_offset % secpercyl)
372 			return (EINVAL);
373 		spp->sdkp_cyloffset = npp->p_offset / secpercyl;
374 		spp->sdkp_nsectors = npp->p_size;
375 	}
376 	sl->sl_magic = SUN_DKMAGIC;
377 
378 	/* Compute the XOR check. */
379 	sp1 = (u_short *)sl;
380 	sp2 = (u_short *)(sl + 1);
381 	sl->sl_cksum = cksum = 0;
382 	while (sp1 < sp2)
383 		cksum ^= *sp1++;
384 	sl->sl_cksum = cksum;
385 
386 	return (0);
387 }
388 
389 /*
390  * Search the bad sector table looking for the specified sector.
391  * Return index if found.
392  * Return -1 if not found.
393  */
394 int
395 isbad(struct dkbad *bt, int cyl, int trk, int sec)
396 {
397 	int i;
398 	long blk, bblk;
399 
400 	blk = ((long)cyl << 16) + (trk << 8) + sec;
401 	for (i = 0; i < 126; i++) {
402 		bblk = ((long)bt->bt_bad[i].bt_cyl << 16) +
403 			bt->bt_bad[i].bt_trksec;
404 		if (blk == bblk)
405 			return (i);
406 		if (blk < bblk || bblk < 0)
407 			break;
408 	}
409 	return (-1);
410 }
411