2 * Copyright (c) 2006-2008 Marcel Moolenaar
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
33 #include <sys/endian.h>
34 #include <sys/kernel.h>
36 #include <sys/limits.h>
38 #include <sys/malloc.h>
39 #include <sys/mutex.h>
40 #include <sys/queue.h>
42 #include <sys/systm.h>
43 #include <sys/sysctl.h>
44 #include <geom/geom.h>
45 #include <geom/geom_int.h>
46 #include <geom/part/g_part.h>
48 #include "g_part_if.h"
50 FEATURE(geom_part_apm, "GEOM partitioning class for Apple-style partitions");
52 struct g_part_apm_table {
53 struct g_part_table base;
59 struct g_part_apm_entry {
60 struct g_part_entry base;
64 static int g_part_apm_add(struct g_part_table *, struct g_part_entry *,
65 struct g_part_parms *);
66 static int g_part_apm_create(struct g_part_table *, struct g_part_parms *);
67 static int g_part_apm_destroy(struct g_part_table *, struct g_part_parms *);
68 static void g_part_apm_dumpconf(struct g_part_table *, struct g_part_entry *,
69 struct sbuf *, const char *);
70 static int g_part_apm_dumpto(struct g_part_table *, struct g_part_entry *);
71 static int g_part_apm_modify(struct g_part_table *, struct g_part_entry *,
72 struct g_part_parms *);
73 static const char *g_part_apm_name(struct g_part_table *, struct g_part_entry *,
75 static int g_part_apm_probe(struct g_part_table *, struct g_consumer *);
76 static int g_part_apm_read(struct g_part_table *, struct g_consumer *);
77 static const char *g_part_apm_type(struct g_part_table *, struct g_part_entry *,
79 static int g_part_apm_write(struct g_part_table *, struct g_consumer *);
80 static int g_part_apm_resize(struct g_part_table *, struct g_part_entry *,
81 struct g_part_parms *);
83 static kobj_method_t g_part_apm_methods[] = {
84 KOBJMETHOD(g_part_add, g_part_apm_add),
85 KOBJMETHOD(g_part_create, g_part_apm_create),
86 KOBJMETHOD(g_part_destroy, g_part_apm_destroy),
87 KOBJMETHOD(g_part_dumpconf, g_part_apm_dumpconf),
88 KOBJMETHOD(g_part_dumpto, g_part_apm_dumpto),
89 KOBJMETHOD(g_part_modify, g_part_apm_modify),
90 KOBJMETHOD(g_part_resize, g_part_apm_resize),
91 KOBJMETHOD(g_part_name, g_part_apm_name),
92 KOBJMETHOD(g_part_probe, g_part_apm_probe),
93 KOBJMETHOD(g_part_read, g_part_apm_read),
94 KOBJMETHOD(g_part_type, g_part_apm_type),
95 KOBJMETHOD(g_part_write, g_part_apm_write),
99 static struct g_part_scheme g_part_apm_scheme = {
102 sizeof(struct g_part_apm_table),
103 .gps_entrysz = sizeof(struct g_part_apm_entry),
107 G_PART_SCHEME_DECLARE(g_part_apm);
110 swab(char *buf, size_t bufsz)
115 for (i = 0; i < bufsz; i += 2) {
123 apm_parse_type(const char *type, char *buf, size_t bufsz)
127 if (type[0] == '!') {
129 if (strlen(type) > bufsz)
131 if (!strcmp(type, APM_ENT_TYPE_SELF) ||
132 !strcmp(type, APM_ENT_TYPE_UNUSED))
134 strncpy(buf, type, bufsz);
137 alias = g_part_alias_name(G_PART_ALIAS_APPLE_BOOT);
138 if (!strcasecmp(type, alias)) {
139 strcpy(buf, APM_ENT_TYPE_APPLE_BOOT);
142 alias = g_part_alias_name(G_PART_ALIAS_APPLE_HFS);
143 if (!strcasecmp(type, alias)) {
144 strcpy(buf, APM_ENT_TYPE_APPLE_HFS);
147 alias = g_part_alias_name(G_PART_ALIAS_APPLE_UFS);
148 if (!strcasecmp(type, alias)) {
149 strcpy(buf, APM_ENT_TYPE_APPLE_UFS);
152 alias = g_part_alias_name(G_PART_ALIAS_FREEBSD);
153 if (!strcasecmp(type, alias)) {
154 strcpy(buf, APM_ENT_TYPE_FREEBSD);
157 alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_NANDFS);
158 if (!strcasecmp(type, alias)) {
159 strcpy(buf, APM_ENT_TYPE_FREEBSD_NANDFS);
162 alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_SWAP);
163 if (!strcasecmp(type, alias)) {
164 strcpy(buf, APM_ENT_TYPE_FREEBSD_SWAP);
167 alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_UFS);
168 if (!strcasecmp(type, alias)) {
169 strcpy(buf, APM_ENT_TYPE_FREEBSD_UFS);
172 alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_VINUM);
173 if (!strcasecmp(type, alias)) {
174 strcpy(buf, APM_ENT_TYPE_FREEBSD_VINUM);
177 alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_ZFS);
178 if (!strcasecmp(type, alias)) {
179 strcpy(buf, APM_ENT_TYPE_FREEBSD_ZFS);
186 apm_read_ent(struct g_consumer *cp, uint32_t blk, struct apm_ent *ent,
189 struct g_provider *pp;
194 buf = g_read_data(cp, pp->sectorsize * blk, pp->sectorsize, &error);
198 swab(buf, pp->sectorsize);
199 ent->ent_sig = be16dec(buf);
200 ent->ent_pmblkcnt = be32dec(buf + 4);
201 ent->ent_start = be32dec(buf + 8);
202 ent->ent_size = be32dec(buf + 12);
203 bcopy(buf + 16, ent->ent_name, sizeof(ent->ent_name));
204 bcopy(buf + 48, ent->ent_type, sizeof(ent->ent_type));
210 g_part_apm_add(struct g_part_table *basetable, struct g_part_entry *baseentry,
211 struct g_part_parms *gpp)
213 struct g_part_apm_entry *entry;
214 struct g_part_apm_table *table;
217 entry = (struct g_part_apm_entry *)baseentry;
218 table = (struct g_part_apm_table *)basetable;
219 entry->ent.ent_sig = APM_ENT_SIG;
220 entry->ent.ent_pmblkcnt = table->self.ent_pmblkcnt;
221 entry->ent.ent_start = gpp->gpp_start;
222 entry->ent.ent_size = gpp->gpp_size;
223 if (baseentry->gpe_deleted) {
224 bzero(entry->ent.ent_type, sizeof(entry->ent.ent_type));
225 bzero(entry->ent.ent_name, sizeof(entry->ent.ent_name));
227 error = apm_parse_type(gpp->gpp_type, entry->ent.ent_type,
228 sizeof(entry->ent.ent_type));
231 if (gpp->gpp_parms & G_PART_PARM_LABEL) {
232 if (strlen(gpp->gpp_label) > sizeof(entry->ent.ent_name))
234 strncpy(entry->ent.ent_name, gpp->gpp_label,
235 sizeof(entry->ent.ent_name));
237 if (baseentry->gpe_index >= table->self.ent_pmblkcnt)
238 table->self.ent_pmblkcnt = baseentry->gpe_index + 1;
239 KASSERT(table->self.ent_size >= table->self.ent_pmblkcnt,
241 KASSERT(table->self.ent_size > baseentry->gpe_index,
247 g_part_apm_create(struct g_part_table *basetable, struct g_part_parms *gpp)
249 struct g_provider *pp;
250 struct g_part_apm_table *table;
253 /* We don't nest, which means that our depth should be 0. */
254 if (basetable->gpt_depth != 0)
257 table = (struct g_part_apm_table *)basetable;
258 pp = gpp->gpp_provider;
259 if (pp->sectorsize != 512 ||
260 pp->mediasize < (2 + 2 * basetable->gpt_entries) * pp->sectorsize)
263 /* APM uses 32-bit LBAs. */
264 last = MIN(pp->mediasize / pp->sectorsize, UINT32_MAX) - 1;
266 basetable->gpt_first = 2 + basetable->gpt_entries;
267 basetable->gpt_last = last;
269 table->ddr.ddr_sig = APM_DDR_SIG;
270 table->ddr.ddr_blksize = pp->sectorsize;
271 table->ddr.ddr_blkcount = last + 1;
273 table->self.ent_sig = APM_ENT_SIG;
274 table->self.ent_pmblkcnt = basetable->gpt_entries + 1;
275 table->self.ent_start = 1;
276 table->self.ent_size = table->self.ent_pmblkcnt;
277 strcpy(table->self.ent_name, "Apple");
278 strcpy(table->self.ent_type, APM_ENT_TYPE_SELF);
283 g_part_apm_destroy(struct g_part_table *basetable, struct g_part_parms *gpp)
286 /* Wipe the first 2 sectors to clear the partitioning. */
287 basetable->gpt_smhead |= 3;
292 g_part_apm_dumpconf(struct g_part_table *table, struct g_part_entry *baseentry,
293 struct sbuf *sb, const char *indent)
296 char name[APM_ENT_NAMELEN + 1];
297 char type[APM_ENT_TYPELEN + 1];
299 struct g_part_apm_entry *entry;
301 entry = (struct g_part_apm_entry *)baseentry;
302 if (indent == NULL) {
303 /* conftxt: libdisk compatibility */
304 sbuf_printf(sb, " xs APPLE xt %s", entry->ent.ent_type);
305 } else if (entry != NULL) {
306 /* confxml: partition entry information */
307 strncpy(u.name, entry->ent.ent_name, APM_ENT_NAMELEN);
308 u.name[APM_ENT_NAMELEN] = '\0';
309 sbuf_printf(sb, "%s<label>", indent);
310 g_conf_printf_escaped(sb, "%s", u.name);
311 sbuf_printf(sb, "</label>\n");
312 strncpy(u.type, entry->ent.ent_type, APM_ENT_TYPELEN);
313 u.type[APM_ENT_TYPELEN] = '\0';
314 sbuf_printf(sb, "%s<rawtype>", indent);
315 g_conf_printf_escaped(sb, "%s", u.type);
316 sbuf_printf(sb, "</rawtype>\n");
318 /* confxml: scheme information */
323 g_part_apm_dumpto(struct g_part_table *table, struct g_part_entry *baseentry)
325 struct g_part_apm_entry *entry;
327 entry = (struct g_part_apm_entry *)baseentry;
328 return ((!strcmp(entry->ent.ent_type, APM_ENT_TYPE_FREEBSD_SWAP))
333 g_part_apm_modify(struct g_part_table *basetable,
334 struct g_part_entry *baseentry, struct g_part_parms *gpp)
336 struct g_part_apm_entry *entry;
339 entry = (struct g_part_apm_entry *)baseentry;
340 if (gpp->gpp_parms & G_PART_PARM_LABEL) {
341 if (strlen(gpp->gpp_label) > sizeof(entry->ent.ent_name))
344 if (gpp->gpp_parms & G_PART_PARM_TYPE) {
345 error = apm_parse_type(gpp->gpp_type, entry->ent.ent_type,
346 sizeof(entry->ent.ent_type));
350 if (gpp->gpp_parms & G_PART_PARM_LABEL) {
351 strncpy(entry->ent.ent_name, gpp->gpp_label,
352 sizeof(entry->ent.ent_name));
358 g_part_apm_resize(struct g_part_table *basetable,
359 struct g_part_entry *baseentry, struct g_part_parms *gpp)
361 struct g_part_apm_entry *entry;
362 struct g_provider *pp;
364 if (baseentry == NULL) {
365 pp = LIST_FIRST(&basetable->gpt_gp->consumer)->provider;
366 basetable->gpt_last = MIN(pp->mediasize / pp->sectorsize,
371 entry = (struct g_part_apm_entry *)baseentry;
372 baseentry->gpe_end = baseentry->gpe_start + gpp->gpp_size - 1;
373 entry->ent.ent_size = gpp->gpp_size;
379 g_part_apm_name(struct g_part_table *table, struct g_part_entry *baseentry,
380 char *buf, size_t bufsz)
383 snprintf(buf, bufsz, "s%d", baseentry->gpe_index + 1);
388 g_part_apm_probe(struct g_part_table *basetable, struct g_consumer *cp)
390 struct g_provider *pp;
391 struct g_part_apm_table *table;
395 /* We don't nest, which means that our depth should be 0. */
396 if (basetable->gpt_depth != 0)
399 table = (struct g_part_apm_table *)basetable;
400 table->tivo_series1 = 0;
403 /* Sanity-check the provider. */
404 if (pp->mediasize < 4 * pp->sectorsize)
407 /* Check that there's a Driver Descriptor Record (DDR). */
408 buf = g_read_data(cp, 0L, pp->sectorsize, &error);
411 if (be16dec(buf) == APM_DDR_SIG) {
412 /* Normal Apple DDR */
413 table->ddr.ddr_sig = be16dec(buf);
414 table->ddr.ddr_blksize = be16dec(buf + 2);
415 table->ddr.ddr_blkcount = be32dec(buf + 4);
417 if (table->ddr.ddr_blksize != pp->sectorsize)
419 if (table->ddr.ddr_blkcount > pp->mediasize / pp->sectorsize)
423 * Check for Tivo drives, which have no DDR and a different
424 * signature. Those whose first two bytes are 14 92 are
425 * Series 2 drives, and aren't supported. Those that start
426 * with 92 14 are series 1 drives and are supported.
428 if (be16dec(buf) != 0x9214) {
429 /* If this is 0x1492 it could be a series 2 drive */
433 table->ddr.ddr_sig = APM_DDR_SIG; /* XXX */
434 table->ddr.ddr_blksize = pp->sectorsize; /* XXX */
435 table->ddr.ddr_blkcount =
436 MIN(pp->mediasize / pp->sectorsize, UINT32_MAX);
437 table->tivo_series1 = 1;
441 /* Check that there's a Partition Map. */
442 error = apm_read_ent(cp, 1, &table->self, table->tivo_series1);
445 if (table->self.ent_sig != APM_ENT_SIG)
447 if (strcmp(table->self.ent_type, APM_ENT_TYPE_SELF))
449 if (table->self.ent_pmblkcnt >= table->ddr.ddr_blkcount)
451 return (G_PART_PROBE_PRI_NORM);
455 g_part_apm_read(struct g_part_table *basetable, struct g_consumer *cp)
458 struct g_part_apm_entry *entry;
459 struct g_part_apm_table *table;
462 table = (struct g_part_apm_table *)basetable;
464 basetable->gpt_first = table->self.ent_size + 1;
465 basetable->gpt_last = table->ddr.ddr_blkcount - 1;
466 basetable->gpt_entries = table->self.ent_size - 1;
468 for (index = table->self.ent_pmblkcnt - 1; index > 0; index--) {
469 error = apm_read_ent(cp, index + 1, &ent, table->tivo_series1);
472 if (!strcmp(ent.ent_type, APM_ENT_TYPE_UNUSED))
474 entry = (struct g_part_apm_entry *)g_part_new_entry(basetable,
475 index, ent.ent_start, ent.ent_start + ent.ent_size - 1);
483 g_part_apm_type(struct g_part_table *basetable, struct g_part_entry *baseentry,
484 char *buf, size_t bufsz)
486 struct g_part_apm_entry *entry;
490 entry = (struct g_part_apm_entry *)baseentry;
491 type = entry->ent.ent_type;
492 if (!strcmp(type, APM_ENT_TYPE_APPLE_BOOT))
493 return (g_part_alias_name(G_PART_ALIAS_APPLE_BOOT));
494 if (!strcmp(type, APM_ENT_TYPE_APPLE_HFS))
495 return (g_part_alias_name(G_PART_ALIAS_APPLE_HFS));
496 if (!strcmp(type, APM_ENT_TYPE_APPLE_UFS))
497 return (g_part_alias_name(G_PART_ALIAS_APPLE_UFS));
498 if (!strcmp(type, APM_ENT_TYPE_FREEBSD))
499 return (g_part_alias_name(G_PART_ALIAS_FREEBSD));
500 if (!strcmp(type, APM_ENT_TYPE_FREEBSD_NANDFS))
501 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_NANDFS));
502 if (!strcmp(type, APM_ENT_TYPE_FREEBSD_SWAP))
503 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_SWAP));
504 if (!strcmp(type, APM_ENT_TYPE_FREEBSD_UFS))
505 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_UFS));
506 if (!strcmp(type, APM_ENT_TYPE_FREEBSD_VINUM))
507 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_VINUM));
508 if (!strcmp(type, APM_ENT_TYPE_FREEBSD_ZFS))
509 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_ZFS));
511 len = MIN(sizeof(entry->ent.ent_type), bufsz - 2);
512 bcopy(type, buf + 1, len);
518 g_part_apm_write(struct g_part_table *basetable, struct g_consumer *cp)
520 struct g_provider *pp;
521 struct g_part_entry *baseentry;
522 struct g_part_apm_entry *entry;
523 struct g_part_apm_table *table;
530 table = (struct g_part_apm_table *)basetable;
532 * Tivo Series 1 disk partitions are currently read-only.
534 if (table->tivo_series1)
537 /* Write the DDR only when we're newly created. */
538 if (basetable->gpt_created) {
539 buf = g_malloc(pp->sectorsize, M_WAITOK | M_ZERO);
540 be16enc(buf, table->ddr.ddr_sig);
541 be16enc(buf + 2, table->ddr.ddr_blksize);
542 be32enc(buf + 4, table->ddr.ddr_blkcount);
543 error = g_write_data(cp, 0, buf, pp->sectorsize);
549 /* Allocate the buffer for all entries */
550 tblsz = table->self.ent_pmblkcnt;
551 buf = g_malloc(tblsz * pp->sectorsize, M_WAITOK | M_ZERO);
553 /* Fill the self entry */
554 be16enc(buf, APM_ENT_SIG);
555 be32enc(buf + 4, table->self.ent_pmblkcnt);
556 be32enc(buf + 8, table->self.ent_start);
557 be32enc(buf + 12, table->self.ent_size);
558 bcopy(table->self.ent_name, buf + 16, sizeof(table->self.ent_name));
559 bcopy(table->self.ent_type, buf + 48, sizeof(table->self.ent_type));
561 baseentry = LIST_FIRST(&basetable->gpt_entry);
562 for (index = 1; index < tblsz; index++) {
563 entry = (baseentry != NULL && index == baseentry->gpe_index)
564 ? (struct g_part_apm_entry *)baseentry : NULL;
565 ptr = buf + index * pp->sectorsize;
566 be16enc(ptr, APM_ENT_SIG);
567 be32enc(ptr + 4, table->self.ent_pmblkcnt);
568 if (entry != NULL && !baseentry->gpe_deleted) {
569 be32enc(ptr + 8, entry->ent.ent_start);
570 be32enc(ptr + 12, entry->ent.ent_size);
571 bcopy(entry->ent.ent_name, ptr + 16,
572 sizeof(entry->ent.ent_name));
573 bcopy(entry->ent.ent_type, ptr + 48,
574 sizeof(entry->ent.ent_type));
576 strcpy(ptr + 48, APM_ENT_TYPE_UNUSED);
579 baseentry = LIST_NEXT(baseentry, gpe_entry);
582 for (index = 0; index < tblsz; index += MAXPHYS / pp->sectorsize) {
583 error = g_write_data(cp, (1 + index) * pp->sectorsize,
584 buf + index * pp->sectorsize,
585 (tblsz - index > MAXPHYS / pp->sectorsize) ? MAXPHYS:
586 (tblsz - index) * pp->sectorsize);