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/diskmbr.h>
34 #include <sys/endian.h>
35 #include <sys/kernel.h>
37 #include <sys/limits.h>
39 #include <sys/malloc.h>
40 #include <sys/mutex.h>
41 #include <sys/queue.h>
43 #include <sys/systm.h>
44 #include <geom/geom.h>
45 #include <geom/part/g_part.h>
47 #include "g_part_if.h"
49 struct g_part_apm_table {
50 struct g_part_table base;
56 struct g_part_apm_entry {
57 struct g_part_entry base;
61 static int g_part_apm_add(struct g_part_table *, struct g_part_entry *,
62 struct g_part_parms *);
63 static int g_part_apm_create(struct g_part_table *, struct g_part_parms *);
64 static int g_part_apm_destroy(struct g_part_table *, struct g_part_parms *);
65 static void g_part_apm_dumpconf(struct g_part_table *, struct g_part_entry *,
66 struct sbuf *, const char *);
67 static int g_part_apm_dumpto(struct g_part_table *, struct g_part_entry *);
68 static int g_part_apm_modify(struct g_part_table *, struct g_part_entry *,
69 struct g_part_parms *);
70 static const char *g_part_apm_name(struct g_part_table *, struct g_part_entry *,
72 static int g_part_apm_probe(struct g_part_table *, struct g_consumer *);
73 static int g_part_apm_read(struct g_part_table *, struct g_consumer *);
74 static const char *g_part_apm_type(struct g_part_table *, struct g_part_entry *,
76 static int g_part_apm_write(struct g_part_table *, struct g_consumer *);
78 static kobj_method_t g_part_apm_methods[] = {
79 KOBJMETHOD(g_part_add, g_part_apm_add),
80 KOBJMETHOD(g_part_create, g_part_apm_create),
81 KOBJMETHOD(g_part_destroy, g_part_apm_destroy),
82 KOBJMETHOD(g_part_dumpconf, g_part_apm_dumpconf),
83 KOBJMETHOD(g_part_dumpto, g_part_apm_dumpto),
84 KOBJMETHOD(g_part_modify, g_part_apm_modify),
85 KOBJMETHOD(g_part_name, g_part_apm_name),
86 KOBJMETHOD(g_part_probe, g_part_apm_probe),
87 KOBJMETHOD(g_part_read, g_part_apm_read),
88 KOBJMETHOD(g_part_type, g_part_apm_type),
89 KOBJMETHOD(g_part_write, g_part_apm_write),
93 static struct g_part_scheme g_part_apm_scheme = {
96 sizeof(struct g_part_apm_table),
97 .gps_entrysz = sizeof(struct g_part_apm_entry),
99 .gps_maxent = INT_MAX,
101 G_PART_SCHEME_DECLARE(g_part_apm);
104 swab(char *buf, size_t bufsz)
109 for (i = 0; i < bufsz; i += 2) {
117 apm_parse_type(const char *type, char *buf, size_t bufsz)
121 if (type[0] == '!') {
123 if (strlen(type) > bufsz)
125 if (!strcmp(type, APM_ENT_TYPE_SELF) ||
126 !strcmp(type, APM_ENT_TYPE_UNUSED))
128 strncpy(buf, type, bufsz);
131 alias = g_part_alias_name(G_PART_ALIAS_APPLE_BOOT);
132 if (!strcasecmp(type, alias)) {
133 strcpy(buf, APM_ENT_TYPE_APPLE_BOOT);
136 alias = g_part_alias_name(G_PART_ALIAS_APPLE_HFS);
137 if (!strcasecmp(type, alias)) {
138 strcpy(buf, APM_ENT_TYPE_APPLE_HFS);
141 alias = g_part_alias_name(G_PART_ALIAS_APPLE_UFS);
142 if (!strcasecmp(type, alias)) {
143 strcpy(buf, APM_ENT_TYPE_APPLE_UFS);
146 alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_BOOT);
147 if (!strcasecmp(type, alias)) {
148 strcpy(buf, APM_ENT_TYPE_APPLE_BOOT);
151 alias = g_part_alias_name(G_PART_ALIAS_FREEBSD);
152 if (!strcasecmp(type, alias)) {
153 strcpy(buf, APM_ENT_TYPE_FREEBSD);
156 alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_SWAP);
157 if (!strcasecmp(type, alias)) {
158 strcpy(buf, APM_ENT_TYPE_FREEBSD_SWAP);
161 alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_UFS);
162 if (!strcasecmp(type, alias)) {
163 strcpy(buf, APM_ENT_TYPE_FREEBSD_UFS);
166 alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_VINUM);
167 if (!strcasecmp(type, alias)) {
168 strcpy(buf, APM_ENT_TYPE_FREEBSD_VINUM);
171 alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_ZFS);
172 if (!strcasecmp(type, alias)) {
173 strcpy(buf, APM_ENT_TYPE_FREEBSD_ZFS);
180 apm_read_ent(struct g_consumer *cp, uint32_t blk, struct apm_ent *ent,
183 struct g_provider *pp;
188 buf = g_read_data(cp, pp->sectorsize * blk, pp->sectorsize, &error);
192 swab(buf, pp->sectorsize);
193 ent->ent_sig = be16dec(buf);
194 ent->ent_pmblkcnt = be32dec(buf + 4);
195 ent->ent_start = be32dec(buf + 8);
196 ent->ent_size = be32dec(buf + 12);
197 bcopy(buf + 16, ent->ent_name, sizeof(ent->ent_name));
198 bcopy(buf + 48, ent->ent_type, sizeof(ent->ent_type));
204 g_part_apm_add(struct g_part_table *basetable, struct g_part_entry *baseentry,
205 struct g_part_parms *gpp)
207 struct g_part_apm_entry *entry;
208 struct g_part_apm_table *table;
211 entry = (struct g_part_apm_entry *)baseentry;
212 table = (struct g_part_apm_table *)basetable;
213 entry->ent.ent_sig = APM_ENT_SIG;
214 entry->ent.ent_pmblkcnt = table->self.ent_pmblkcnt;
215 entry->ent.ent_start = gpp->gpp_start;
216 entry->ent.ent_size = gpp->gpp_size;
217 if (baseentry->gpe_deleted) {
218 bzero(entry->ent.ent_type, sizeof(entry->ent.ent_type));
219 bzero(entry->ent.ent_name, sizeof(entry->ent.ent_name));
221 error = apm_parse_type(gpp->gpp_type, entry->ent.ent_type,
222 sizeof(entry->ent.ent_type));
225 if (gpp->gpp_parms & G_PART_PARM_LABEL) {
226 if (strlen(gpp->gpp_label) > sizeof(entry->ent.ent_name))
228 strncpy(entry->ent.ent_name, gpp->gpp_label,
229 sizeof(entry->ent.ent_name));
235 g_part_apm_create(struct g_part_table *basetable, struct g_part_parms *gpp)
237 struct g_provider *pp;
238 struct g_part_apm_table *table;
241 /* We don't nest, which means that our depth should be 0. */
242 if (basetable->gpt_depth != 0)
245 table = (struct g_part_apm_table *)basetable;
246 pp = gpp->gpp_provider;
247 if (pp->sectorsize != 512 ||
248 pp->mediasize < (2 + 2 * basetable->gpt_entries) * pp->sectorsize)
251 /* APM uses 32-bit LBAs. */
252 last = MIN(pp->mediasize / pp->sectorsize, 0xffffffff) - 1;
254 basetable->gpt_first = 2 + basetable->gpt_entries;
255 basetable->gpt_last = last;
257 table->ddr.ddr_sig = APM_DDR_SIG;
258 table->ddr.ddr_blksize = pp->sectorsize;
259 table->ddr.ddr_blkcount = last + 1;
261 table->self.ent_sig = APM_ENT_SIG;
262 table->self.ent_pmblkcnt = basetable->gpt_entries + 1;
263 table->self.ent_start = 1;
264 table->self.ent_size = table->self.ent_pmblkcnt;
265 strcpy(table->self.ent_name, "Apple");
266 strcpy(table->self.ent_type, APM_ENT_TYPE_SELF);
271 g_part_apm_destroy(struct g_part_table *basetable, struct g_part_parms *gpp)
274 /* Wipe the first 2 sectors to clear the partitioning. */
275 basetable->gpt_smhead |= 3;
280 g_part_apm_dumpconf(struct g_part_table *table, struct g_part_entry *baseentry,
281 struct sbuf *sb, const char *indent)
284 char name[APM_ENT_NAMELEN + 1];
285 char type[APM_ENT_TYPELEN + 1];
287 struct g_part_apm_entry *entry;
289 entry = (struct g_part_apm_entry *)baseentry;
290 if (indent == NULL) {
291 /* conftxt: libdisk compatibility */
292 sbuf_printf(sb, " xs APPLE xt %s", entry->ent.ent_type);
293 } else if (entry != NULL) {
294 /* confxml: partition entry information */
295 strncpy(u.name, entry->ent.ent_name, APM_ENT_NAMELEN);
296 u.name[APM_ENT_NAMELEN] = '\0';
297 sbuf_printf(sb, "%s<label>%s</label>\n", indent, u.name);
298 strncpy(u.type, entry->ent.ent_type, APM_ENT_TYPELEN);
299 u.type[APM_ENT_TYPELEN] = '\0';
300 sbuf_printf(sb, "%s<rawtype>%s</rawtype>\n", indent, u.type);
302 /* confxml: scheme information */
307 g_part_apm_dumpto(struct g_part_table *table, struct g_part_entry *baseentry)
309 struct g_part_apm_entry *entry;
311 entry = (struct g_part_apm_entry *)baseentry;
312 return ((!strcmp(entry->ent.ent_type, APM_ENT_TYPE_FREEBSD_SWAP))
317 g_part_apm_modify(struct g_part_table *basetable,
318 struct g_part_entry *baseentry, struct g_part_parms *gpp)
320 struct g_part_apm_entry *entry;
323 entry = (struct g_part_apm_entry *)baseentry;
324 if (gpp->gpp_parms & G_PART_PARM_LABEL) {
325 if (strlen(gpp->gpp_label) > sizeof(entry->ent.ent_name))
328 if (gpp->gpp_parms & G_PART_PARM_TYPE) {
329 error = apm_parse_type(gpp->gpp_type, entry->ent.ent_type,
330 sizeof(entry->ent.ent_type));
334 if (gpp->gpp_parms & G_PART_PARM_LABEL) {
335 strncpy(entry->ent.ent_name, gpp->gpp_label,
336 sizeof(entry->ent.ent_name));
342 g_part_apm_name(struct g_part_table *table, struct g_part_entry *baseentry,
343 char *buf, size_t bufsz)
346 snprintf(buf, bufsz, "s%d", baseentry->gpe_index + 1);
351 g_part_apm_probe(struct g_part_table *basetable, struct g_consumer *cp)
353 struct g_provider *pp;
354 struct g_part_apm_table *table;
358 /* We don't nest, which means that our depth should be 0. */
359 if (basetable->gpt_depth != 0)
362 table = (struct g_part_apm_table *)basetable;
363 table->tivo_series1 = 0;
366 /* Sanity-check the provider. */
367 if (pp->mediasize < 4 * pp->sectorsize)
370 /* Check that there's a Driver Descriptor Record (DDR). */
371 buf = g_read_data(cp, 0L, pp->sectorsize, &error);
374 if (be16dec(buf) == be16toh(APM_DDR_SIG)) {
375 /* Normal Apple DDR */
376 table->ddr.ddr_sig = be16dec(buf);
377 table->ddr.ddr_blksize = be16dec(buf + 2);
378 table->ddr.ddr_blkcount = be32dec(buf + 4);
380 if (table->ddr.ddr_blksize != pp->sectorsize)
384 * Check for Tivo drives, which have no DDR and a different
385 * signature. Those whose first two bytes are 14 92 are
386 * Series 2 drives, and aren't supported. Those that start
387 * with 92 14 are series 1 drives and are supported.
389 if (be16dec(buf) != 0x9214) {
390 /* If this is 0x1492 it could be a series 2 drive */
394 table->ddr.ddr_sig = APM_DDR_SIG; /* XXX */
395 table->ddr.ddr_blksize = pp->sectorsize; /* XXX */
396 table->ddr.ddr_blkcount = pp->mediasize / pp->sectorsize;/* XXX */
397 table->tivo_series1 = 1;
401 /* Check that there's a Partition Map. */
402 error = apm_read_ent(cp, 1, &table->self, table->tivo_series1);
405 if (table->self.ent_sig != APM_ENT_SIG)
407 if (strcmp(table->self.ent_type, APM_ENT_TYPE_SELF))
409 if (table->self.ent_pmblkcnt >= table->ddr.ddr_blkcount)
411 return (G_PART_PROBE_PRI_NORM);
415 g_part_apm_read(struct g_part_table *basetable, struct g_consumer *cp)
418 struct g_part_apm_entry *entry;
419 struct g_part_apm_table *table;
422 table = (struct g_part_apm_table *)basetable;
424 basetable->gpt_first = table->self.ent_pmblkcnt + 1;
425 basetable->gpt_last = table->ddr.ddr_blkcount - 1;
426 basetable->gpt_entries = table->self.ent_pmblkcnt - 1;
428 for (index = table->self.ent_pmblkcnt - 1; index > 0; index--) {
429 error = apm_read_ent(cp, index + 1, &ent, table->tivo_series1);
432 if (!strcmp(ent.ent_type, APM_ENT_TYPE_UNUSED))
434 entry = (struct g_part_apm_entry *)g_part_new_entry(basetable,
435 index, ent.ent_start, ent.ent_start + ent.ent_size - 1);
443 g_part_apm_type(struct g_part_table *basetable, struct g_part_entry *baseentry,
444 char *buf, size_t bufsz)
446 struct g_part_apm_entry *entry;
450 entry = (struct g_part_apm_entry *)baseentry;
451 type = entry->ent.ent_type;
452 if (!strcmp(type, APM_ENT_TYPE_APPLE_BOOT))
453 return (g_part_alias_name(G_PART_ALIAS_APPLE_BOOT));
454 if (!strcmp(type, APM_ENT_TYPE_APPLE_HFS))
455 return (g_part_alias_name(G_PART_ALIAS_APPLE_HFS));
456 if (!strcmp(type, APM_ENT_TYPE_APPLE_UFS))
457 return (g_part_alias_name(G_PART_ALIAS_APPLE_UFS));
458 if (!strcmp(type, APM_ENT_TYPE_FREEBSD))
459 return (g_part_alias_name(G_PART_ALIAS_FREEBSD));
460 if (!strcmp(type, APM_ENT_TYPE_FREEBSD_SWAP))
461 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_SWAP));
462 if (!strcmp(type, APM_ENT_TYPE_FREEBSD_UFS))
463 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_UFS));
464 if (!strcmp(type, APM_ENT_TYPE_FREEBSD_VINUM))
465 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_VINUM));
466 if (!strcmp(type, APM_ENT_TYPE_FREEBSD_ZFS))
467 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_ZFS));
469 len = MIN(sizeof(entry->ent.ent_type), bufsz - 2);
470 bcopy(type, buf + 1, len);
476 g_part_apm_write(struct g_part_table *basetable, struct g_consumer *cp)
479 struct g_part_entry *baseentry;
480 struct g_part_apm_entry *entry;
481 struct g_part_apm_table *table;
484 table = (struct g_part_apm_table *)basetable;
486 * Tivo Series 1 disk partitions are currently read-only.
488 if (table->tivo_series1)
490 bzero(buf, sizeof(buf));
492 /* Write the DDR and 'self' entry only when we're newly created. */
493 if (basetable->gpt_created) {
494 be16enc(buf, table->ddr.ddr_sig);
495 be16enc(buf + 2, table->ddr.ddr_blksize);
496 be32enc(buf + 4, table->ddr.ddr_blkcount);
497 error = g_write_data(cp, 0, buf, sizeof(buf));
502 be16enc(buf, table->self.ent_sig);
504 be32enc(buf + 4, table->self.ent_pmblkcnt);
506 if (basetable->gpt_created) {
507 be32enc(buf + 8, table->self.ent_start);
508 be32enc(buf + 12, table->self.ent_size);
509 bcopy(table->self.ent_name, buf + 16,
510 sizeof(table->self.ent_name));
511 bcopy(table->self.ent_type, buf + 48,
512 sizeof(table->self.ent_type));
513 error = g_write_data(cp, 512, buf, sizeof(buf));
518 baseentry = LIST_FIRST(&basetable->gpt_entry);
519 for (index = 1; index <= basetable->gpt_entries; index++) {
520 entry = (baseentry != NULL && index == baseentry->gpe_index)
521 ? (struct g_part_apm_entry *)baseentry : NULL;
522 if (entry != NULL && !baseentry->gpe_deleted) {
523 be32enc(buf + 8, entry->ent.ent_start);
524 be32enc(buf + 12, entry->ent.ent_size);
525 bcopy(entry->ent.ent_name, buf + 16,
526 sizeof(entry->ent.ent_name));
527 bcopy(entry->ent.ent_type, buf + 48,
528 sizeof(entry->ent.ent_type));
530 bzero(buf + 8, 4 + 4 + 32 + 32);
531 strcpy(buf + 48, APM_ENT_TYPE_UNUSED);
533 error = g_write_data(cp, (index + 1) * 512, buf, sizeof(buf));
537 baseentry = LIST_NEXT(baseentry, gpe_entry);