dkwedge_bsdlabel.c revision 1.1 1 /* $NetBSD: dkwedge_bsdlabel.c,v 1.1 2004/10/04 01:16:39 thorpej Exp $ */
2
3 /*-
4 * Copyright (c) 2004 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the NetBSD
21 * Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 /*
40 * Adapted from kern/subr_disk_mbr.c:
41 *
42 * Copyright (c) 1982, 1986, 1988 Regents of the University of California.
43 * All rights reserved.
44 *
45 * Redistribution and use in source and binary forms, with or without
46 * modification, are permitted provided that the following conditions
47 * are met:
48 * 1. Redistributions of source code must retain the above copyright
49 * notice, this list of conditions and the following disclaimer.
50 * 2. Redistributions in binary form must reproduce the above copyright
51 * notice, this list of conditions and the following disclaimer in the
52 * documentation and/or other materials provided with the distribution.
53 * 3. Neither the name of the University nor the names of its contributors
54 * may be used to endorse or promote products derived from this software
55 * without specific prior written permission.
56 *
57 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
58 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
59 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
60 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
61 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
62 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
63 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
64 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
65 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
66 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
67 * SUCH DAMAGE.
68 *
69 * @(#)ufs_disksubr.c 7.16 (Berkeley) 5/4/91
70 */
71
72 /*
73 * 4.4BSD disklabel support for disk wedges
74 *
75 * Here is the basic search algorithm in use here:
76 *
77 * For historical reasons, we scan for x86-style MBR partitions looking
78 * for a MBR_PTYPE_NETBSD (or MBR_PTYPE_386BSD) partition. The first
79 * 4.4BSD disklabel found in the 2nd sector of such a partition is used.
80 * We assume that the 4.4BSD disklabel describes all partitions on the
81 * disk; we do not use any partition information from the MBR partition
82 * table.
83 *
84 * If that fails, then we fall back on a table of known locations for
85 * various platforms.
86 */
87
88 #include <sys/cdefs.h>
89 __KERNEL_RCSID(0, "$NetBSD: dkwedge_bsdlabel.c,v 1.1 2004/10/04 01:16:39 thorpej Exp $");
90
91 #include <sys/param.h>
92 #include <sys/systm.h>
93 #include <sys/proc.h>
94 #include <sys/errno.h>
95 #include <sys/disk.h>
96 #include <sys/vnode.h>
97 #include <sys/malloc.h>
98
99 #include <sys/bootblock.h>
100 #include <sys/disklabel.h>
101
102 #define BSD44_MBR_LABELSECTOR 1
103
104 #define DISKLABEL_SIZE(x) \
105 (offsetof(struct disklabel, d_partitions) + \
106 (sizeof(struct partition) * (x)))
107
108 /*
109 * Note the smallest MAXPARTITIONS was 8, so we allow a disklabel
110 * that size to be locted at the end of the sector.
111 */
112 #define DISKLABEL_MINSIZE DISKLABEL_SIZE(8)
113
114 /*
115 * Table of known platform-specific disklabel locations.
116 */
117 static const struct disklabel_location {
118 daddr_t label_sector; /* sector containing label */
119 size_t label_offset; /* byte offset of label in sector */
120 } disklabel_locations[] = {
121 { 0, 0 }, /* mvme68k, next68k */
122 { 0, 64 }, /* algor, alpha, amiga, amigappc, evbmips, evbppc,
123 luna68k, mac68k, macppc, news68k, newsmips,
124 pc532, pdp11, pmax, vax, x68k */
125 { 0, 128 }, /* sparc, sun68k */
126 { 1, 0 }, /* amd64, arc, arm, bebox, cobalt, evbppc, hp700,
127 hpcarm, hpcmips, i386, ibmnws, mipsco, mvmeppc,
128 ofppc, playstation2, pmppc, prep, sandpoint,
129 sbmips, sgimips, sh3, sh5 */
130 /* XXX atari is weird */
131 { 2, 0 }, /* cesfic, hp300 */
132
133 { -1, 0 },
134 };
135
136 #define SCAN_CONTINUE 0
137 #define SCAN_FOUND 1
138 #define SCAN_ERROR 2
139
140 typedef struct mbr_args {
141 struct disk *pdk;
142 struct vnode *vp;
143 void *buf;
144 int error;
145 } mbr_args_t;
146
147 static const char *
148 bsdlabel_fstype_to_str(uint8_t fstype)
149 {
150 const char *str;
151
152 switch (fstype) {
153 case FS_UNUSED: str = DKW_PTYPE_UNUSED; break;
154 case FS_SWAP: str = DKW_PTYPE_SWAP; break;
155 case FS_BSDFFS: str = DKW_PTYPE_FFS; break;
156 case FS_MSDOS: str = DKW_PTYPE_FAT; break;
157 case FS_BSDLFS: str = DKW_PTYPE_LFS; break;
158 case FS_ISO9660: str = DKW_PTYPE_ISO9660; break;
159 case FS_ADOS: str = DKW_PTYPE_AMIGADOS; break;
160 case FS_HFS: str = DKW_PTYPE_APPLEHFS; break;
161 case FS_FILECORE: str = DKW_PTYPE_FILECORE; break;
162 case FS_EX2FS: str = DKW_PTYPE_EXT2FS; break;
163 case FS_NTFS: str = DKW_PTYPE_NTFS; break;
164 case FS_RAID: str = DKW_PTYPE_RAIDFRAME; break;
165 case FS_CCD: str = DKW_PTYPE_CCD; break;
166 case FS_APPLEUFS: str = DKW_PTYPE_APPLEUFS; break;
167 case FS_VINUM: str = "vinum"; break;
168 default: str = NULL; break;
169 }
170
171 return (str);
172 }
173
174 static void
175 swap_disklabel(struct disklabel *lp)
176 {
177 int i;
178
179 #define SWAP16(x) lp->x = bswap16(lp->x)
180 #define SWAP32(x) lp->x = bswap32(lp->x)
181
182 SWAP32(d_magic);
183 SWAP16(d_type);
184 SWAP16(d_subtype);
185 SWAP32(d_secsize);
186 SWAP32(d_nsectors);
187 SWAP32(d_ntracks);
188 SWAP32(d_ncylinders);
189 SWAP32(d_secpercyl);
190 SWAP32(d_secperunit);
191 SWAP16(d_sparespertrack);
192 SWAP16(d_sparespercyl);
193 SWAP32(d_acylinders);
194 SWAP16(d_rpm);
195 SWAP16(d_interleave);
196 SWAP16(d_trackskew);
197 SWAP16(d_cylskew);
198 SWAP32(d_headswitch);
199 SWAP32(d_trkseek);
200 SWAP32(d_flags);
201
202 for (i = 0; i < NDDATA; i++)
203 SWAP32(d_drivedata[i]);
204 for (i = 0; i < NSPARE; i++)
205 SWAP32(d_spare[i]);
206
207 SWAP32(d_magic2);
208 SWAP16(d_checksum);
209 SWAP16(d_npartitions);
210 SWAP32(d_bbsize);
211 SWAP32(d_sbsize);
212
213 for (i = 0; i < lp->d_npartitions; i++) {
214 SWAP32(d_partitions[i].p_size);
215 SWAP32(d_partitions[i].p_offset);
216 SWAP32(d_partitions[i].p_fsize);
217 SWAP16(d_partitions[i].p_cpg);
218 }
219
220 #undef SWAP16
221 #undef SWAP32
222 }
223
224 static int
225 validate_label(mbr_args_t *a, daddr_t label_sector, size_t label_offset)
226 {
227 struct disklabel *lp;
228 caddr_t lp_lim;
229 int i, error;
230
231 error = dkwedge_read(a->pdk, a->vp, label_sector, a->buf, DEV_BSIZE);
232 if (error) {
233 aprint_error("%s: unable to read BSD disklabel @ %" PRId64
234 ", error = %d\n", a->pdk->dk_name, label_sector, error);
235 a->error = error;
236 return (SCAN_ERROR);
237 }
238
239 /*
240 * We ignore label_offset; this seems to have not been used
241 * consistently in the old code, requiring us to do the search
242 * in the sector.
243 */
244 lp = a->buf;
245 lp_lim = (caddr_t)a->buf + DEV_BSIZE - DISKLABEL_MINSIZE;
246 for (;; lp = (void *)((caddr_t)lp + sizeof(uint32_t))) {
247 if ((caddr_t)lp > lp_lim)
248 return (SCAN_CONTINUE);
249 label_offset = (size_t)((caddr_t)lp - (caddr_t)a->buf);
250 if (lp->d_magic != DISKMAGIC ||
251 lp->d_magic != DISKMAGIC) {
252 if (lp->d_magic == bswap32(DISKMAGIC) &&
253 lp->d_magic == bswap32(DISKMAGIC)) {
254 /*
255 * Label is in the other byte order; validate
256 * its length, then byte-swap it.
257 */
258 if ((caddr_t)lp +
259 DISKLABEL_SIZE(bswap16(lp->d_npartitions)) >
260 (caddr_t)a->buf + DEV_BSIZE) {
261 aprint_error("%s: BSD disklabel @ "
262 "%" PRId64
263 "+%zd has bogus partition "
264 "count (%u)\n", a->pdk->dk_name,
265 label_sector, label_offset,
266 bswap16(lp->d_npartitions));
267 continue;
268 }
269 swap_disklabel(lp);
270 } else
271 continue;
272 } else {
273 /*
274 * Validate the disklabel length.
275 */
276 if ((caddr_t)lp + DISKLABEL_SIZE(lp->d_npartitions) >
277 (caddr_t)a->buf + DEV_BSIZE) {
278 aprint_error("%s: BSD disklabel @ %" PRId64
279 "+%zd has bogus partition count (%u)\n",
280 a->pdk->dk_name, label_sector,
281 label_offset, lp->d_npartitions);
282 continue;
283 }
284 }
285
286 /*
287 * Disklabel is now in the right order and we have validated
288 * the partition count, checksum it as the final check.
289 */
290 if (dkcksum(lp) != 0) {
291 aprint_error("%s: BSD disklabel @ %" PRId64
292 "+%zd has bad checksum\n", a->pdk->dk_name,
293 label_sector, label_offset);
294 continue;
295 }
296
297 /*
298 * Ok, we have a valid NetBSD disklabel, add wedges for it.
299 */
300 for (i = 0; i < lp->d_npartitions; i++) {
301 struct dkwedge_info dkw;
302 struct partition *p;
303 const char *ptype;
304
305 p = &lp->d_partitions[i];
306
307 if (p->p_fstype == FS_UNUSED)
308 continue;
309 if ((ptype =
310 bsdlabel_fstype_to_str(p->p_fstype)) == NULL) {
311 /*
312 * XXX Should probably just add these...
313 * XXX maybe just have an empty ptype?
314 */
315 aprint_verbose("%s: skipping partition %d, "
316 "type %d\n", a->pdk->dk_name, i,
317 p->p_fstype);
318 continue;
319 }
320 strcpy(dkw.dkw_ptype, ptype);
321
322 strcpy(dkw.dkw_parent, a->pdk->dk_name);
323 dkw.dkw_offset = p->p_offset;
324 dkw.dkw_size = p->p_size;
325
326 /*
327 * These get historical disk naming style
328 * wedge names.
329 */
330 snprintf(dkw.dkw_wname, sizeof(dkw.dkw_wname),
331 "%s%c", a->pdk->dk_name, 'a' + i);
332
333 error = dkwedge_add(&dkw);
334 if (error == EEXIST)
335 aprint_error("%s: wedge named '%s' already "
336 "exists, manual intervention required\n",
337 a->pdk->dk_name, dkw.dkw_wname);
338 else if (error)
339 aprint_error("%s: error %d adding partition "
340 "%d type %d\n", a->pdk->dk_name, error,
341 i, p->p_fstype);
342 }
343 return (SCAN_FOUND);
344 }
345 }
346
347 static int
348 scan_mbr(mbr_args_t *a, int (*actn)(mbr_args_t *, struct mbr_partition *,
349 int, u_int))
350 {
351 struct mbr_partition ptns[MBR_PART_COUNT];
352 struct mbr_partition *dp;
353 struct mbr_sector *mbr;
354 u_int ext_base, this_ext, next_ext;
355 int i, rval;
356 #ifdef COMPAT_386BSD_MBRPART
357 int dp_386bsd = -1;
358 #endif
359
360 ext_base = 0;
361 this_ext = 0;
362 for (;;) {
363 a->error = dkwedge_read(a->pdk, a->vp, this_ext, a->buf,
364 DEV_BSIZE);
365 if (a->error) {
366 aprint_error("%s: unable to read MBR @ %u, "
367 "error = %d\n", a->pdk->dk_name, this_ext,
368 a->error);
369 return (SCAN_ERROR);
370 }
371
372 mbr = a->buf;
373 if (mbr->mbr_magic != htole16(MBR_MAGIC))
374 return (SCAN_CONTINUE);
375
376 /* Copy data out of buffer so action can use the buffer. */
377 memcpy(ptns, &mbr->mbr_parts, sizeof(ptns));
378
379 /* Looks for NetBSD partition. */
380 next_ext = 0;
381 dp = ptns;
382 for (i = 0; i < MBR_PART_COUNT; i++, dp++) {
383 if (dp->mbrp_type == 0)
384 continue;
385 if (MBR_IS_EXTENDED(dp->mbrp_type)) {
386 next_ext = le32toh(dp->mbrp_start);
387 continue;
388 }
389 #ifdef COMPAT_386BSD_MBRPART
390 if (dp->mbrp_type == MBR_PTYPE_386BSD) {
391 /*
392 * If more than one matches, take last,
393 * as NetBSD install tool does.
394 */
395 if (this_ext == 0)
396 dp_386bsd = i;
397 continue;
398 }
399 #endif
400 rval = (*actn)(a, dp, i, this_ext);
401 if (rval != SCAN_CONTINUE)
402 return (rval);
403 }
404 if (next_ext == 0)
405 break;
406 if (ext_base == 0) {
407 ext_base = next_ext;
408 next_ext = 0;
409 }
410 next_ext += ext_base;
411 if (next_ext <= this_ext)
412 break;
413 this_ext = next_ext;
414 }
415 #ifdef COMPAT_386BSD_MBRPART
416 if (this_ext == 0 && dp_386bsd != -1)
417 return ((*actn)(a, &ptns[dp_386bsd], dp_386bsd, 0));
418 #endif
419 return (SCAN_CONTINUE);
420 }
421
422 static int
423 look_netbsd_part(mbr_args_t *a, struct mbr_partition *dp, int slot,
424 u_int ext_base)
425 {
426 int ptn_base = ext_base + le32toh(dp->mbrp_start);
427 int rval;
428
429 if (
430 #ifdef COMPAT_386BSD_MBRPART
431 dp->mbrp_type == MBR_PTYPE_386BSD ||
432 #endif
433 dp->mbrp_type == MBR_PTYPE_NETBSD) {
434 rval = validate_label(a, ptn_base + BSD44_MBR_LABELSECTOR, 0);
435
436 /* If we got a NetBSD label, look no further. */
437 if (rval == SCAN_FOUND)
438 return (rval);
439 }
440
441 return (SCAN_CONTINUE);
442 }
443
444 static int
445 dkwedge_discover_bsdlabel(struct disk *pdk, struct vnode *vp)
446 {
447 mbr_args_t a;
448 const struct disklabel_location *dl;
449 int rval;
450
451 a.pdk = pdk;
452 a.vp = vp;
453 a.buf = malloc(DEV_BSIZE, M_DEVBUF, M_WAITOK);
454 a.error = 0;
455
456 /* MBR search. */
457 rval = scan_mbr(&a, look_netbsd_part);
458 if (rval != SCAN_CONTINUE) {
459 if (rval == SCAN_FOUND)
460 a.error = 0; /* found it, wedges installed */
461 goto out;
462 }
463
464 /* Known location search. */
465 for (dl = disklabel_locations; dl->label_sector != -1; dl++) {
466 rval = validate_label(&a, dl->label_sector, dl->label_offset);
467 if (rval != SCAN_CONTINUE) {
468 if (rval == SCAN_FOUND)
469 a.error = 0; /* found it, wedges installed */
470 goto out;
471 }
472 }
473
474 /* No NetBSD disklabel found. */
475 a.error = ESRCH;
476 out:
477 free(a.buf, M_DEVBUF);
478 return (a.error);
479 }
480
481 DKWEDGE_DISCOVERY_METHOD_DECL(BSD44, 5, dkwedge_discover_bsdlabel);
482