sys/geom/part/g_part_vtoc8.c

   1 /*-
   2  * Copyright (c) 2008 Marcel Moolenaar
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   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.
  14  *
  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.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include <sys/param.h>
  31 #include <sys/bio.h>
  32 #include <sys/endian.h>
  33 #include <sys/kernel.h>
  34 #include <sys/kobj.h>
  35 #include <sys/limits.h>
  36 #include <sys/lock.h>
  37 #include <sys/malloc.h>
  38 #include <sys/mutex.h>
  39 #include <sys/queue.h>
  40 #include <sys/sbuf.h>
  41 #include <sys/systm.h>
  42 #include <sys/sysctl.h>
  43 #include <sys/vtoc.h>
  44 #include <geom/geom.h>
  45 #include <geom/part/g_part.h>
  46
  47 #include "g_part_if.h"
  48
  49 FEATURE(geom_part_vtoc8, "GEOM partitioning class for SMI VTOC8 disk labels");
  50
  51 struct g_part_vtoc8_table {
  52         struct g_part_table     base;
  53         struct vtoc8            vtoc;
  54         uint32_t                secpercyl;
  55 };
  56
  57 static int g_part_vtoc8_add(struct g_part_table *, struct g_part_entry *,
  58     struct g_part_parms *);
  59 static int g_part_vtoc8_create(struct g_part_table *, struct g_part_parms *);
  60 static int g_part_vtoc8_destroy(struct g_part_table *, struct g_part_parms *);
  61 static void g_part_vtoc8_dumpconf(struct g_part_table *,
  62     struct g_part_entry *, struct sbuf *, const char *);
  63 static int g_part_vtoc8_dumpto(struct g_part_table *, struct g_part_entry *);
  64 static int g_part_vtoc8_modify(struct g_part_table *, struct g_part_entry *,
  65     struct g_part_parms *);
  66 static const char *g_part_vtoc8_name(struct g_part_table *,
  67     struct g_part_entry *, char *, size_t);
  68 static int g_part_vtoc8_probe(struct g_part_table *, struct g_consumer *);
  69 static int g_part_vtoc8_read(struct g_part_table *, struct g_consumer *);
  70 static const char *g_part_vtoc8_type(struct g_part_table *,
  71     struct g_part_entry *, char *, size_t);
  72 static int g_part_vtoc8_write(struct g_part_table *, struct g_consumer *);
  73 static int g_part_vtoc8_resize(struct g_part_table *, struct g_part_entry *,
  74     struct g_part_parms *);
  75
  76 static kobj_method_t g_part_vtoc8_methods[] = {
  77         KOBJMETHOD(g_part_add,          g_part_vtoc8_add),
  78         KOBJMETHOD(g_part_create,       g_part_vtoc8_create),
  79         KOBJMETHOD(g_part_destroy,      g_part_vtoc8_destroy),
  80         KOBJMETHOD(g_part_dumpconf,     g_part_vtoc8_dumpconf),
  81         KOBJMETHOD(g_part_dumpto,       g_part_vtoc8_dumpto),
  82         KOBJMETHOD(g_part_modify,       g_part_vtoc8_modify),
  83         KOBJMETHOD(g_part_resize,       g_part_vtoc8_resize),
  84         KOBJMETHOD(g_part_name,         g_part_vtoc8_name),
  85         KOBJMETHOD(g_part_probe,        g_part_vtoc8_probe),
  86         KOBJMETHOD(g_part_read,         g_part_vtoc8_read),
  87         KOBJMETHOD(g_part_type,         g_part_vtoc8_type),
  88         KOBJMETHOD(g_part_write,        g_part_vtoc8_write),
  89         { 0, 0 }
  90 };
  91
  92 static struct g_part_scheme g_part_vtoc8_scheme = {
  93         "VTOC8",
  94         g_part_vtoc8_methods,
  95         sizeof(struct g_part_vtoc8_table),
  96         .gps_entrysz = sizeof(struct g_part_entry),
  97         .gps_minent = VTOC8_NPARTS,
  98         .gps_maxent = VTOC8_NPARTS,
  99 };
 100 G_PART_SCHEME_DECLARE(g_part_vtoc8);
 101
 102 static int
 103 vtoc8_parse_type(const char *type, uint16_t *tag)
 104 {
 105         const char *alias;
 106         char *endp;
 107         long lt;
 108
 109         if (type[0] == '!') {
 110                 lt = strtol(type + 1, &endp, 0);
 111                 if (type[1] == '\0' || *endp != '\0' || lt <= 0 ||
 112                     lt >= 65536)
 113                         return (EINVAL);
 114                 *tag = (uint16_t)lt;
 115                 return (0);
 116         }
 117         alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_SWAP);
 118         if (!strcasecmp(type, alias)) {
 119                 *tag = VTOC_TAG_FREEBSD_SWAP;
 120                 return (0);
 121         }
 122         alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_UFS);
 123         if (!strcasecmp(type, alias)) {
 124                 *tag = VTOC_TAG_FREEBSD_UFS;
 125                 return (0);
 126         }
 127         alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_VINUM);
 128         if (!strcasecmp(type, alias)) {
 129                 *tag = VTOC_TAG_FREEBSD_VINUM;
 130                 return (0);
 131         }
 132         alias = g_part_alias_name(G_PART_ALIAS_FREEBSD_ZFS);
 133         if (!strcasecmp(type, alias)) {
 134                 *tag = VTOC_TAG_FREEBSD_ZFS;
 135                 return (0);
 136         }
 137         return (EINVAL);
 138 }
 139
 140 static int
 141 g_part_vtoc8_add(struct g_part_table *basetable, struct g_part_entry *entry,
 142     struct g_part_parms *gpp)
 143 {
 144         struct g_part_vtoc8_table *table;
 145         int error, index;
 146         uint64_t start, size;
 147         uint16_t tag;
 148
 149         if (gpp->gpp_parms & G_PART_PARM_LABEL)
 150                 return (EINVAL);
 151
 152         error = vtoc8_parse_type(gpp->gpp_type, &tag);
 153         if (error)
 154                 return (error);
 155
 156         table = (struct g_part_vtoc8_table *)basetable;
 157         index = entry->gpe_index - 1;
 158
 159         start = gpp->gpp_start;
 160         size = gpp->gpp_size;
 161         if (start % table->secpercyl) {
 162                 size = size - table->secpercyl + (start % table->secpercyl);
 163                 start = start - (start % table->secpercyl) + table->secpercyl;
 164         }
 165         if (size % table->secpercyl)
 166                 size = size - (size % table->secpercyl);
 167         if (size < table->secpercyl)
 168                 return (EINVAL);
 169
 170         KASSERT(entry->gpe_start <= start, (__func__));
 171         KASSERT(entry->gpe_end >= start + size - 1, (__func__));
 172         entry->gpe_start = start;
 173         entry->gpe_end = start + size - 1;
 174
 175         be16enc(&table->vtoc.part[index].tag, tag);
 176         be16enc(&table->vtoc.part[index].flag, 0);
 177         be32enc(&table->vtoc.timestamp[index], 0);
 178         be32enc(&table->vtoc.map[index].cyl, start / table->secpercyl);
 179         be32enc(&table->vtoc.map[index].nblks, size);
 180         return (0);
 181 }
 182
 183 static int
 184 g_part_vtoc8_create(struct g_part_table *basetable, struct g_part_parms *gpp)
 185 {
 186         struct g_provider *pp;
 187         struct g_part_entry *entry;
 188         struct g_part_vtoc8_table *table;
 189         uint64_t msize;
 190         uint32_t acyls, ncyls, pcyls;
 191
 192         pp = gpp->gpp_provider;
 193
 194         if (pp->sectorsize < sizeof(struct vtoc8))
 195                 return (ENOSPC);
 196         if (pp->sectorsize > sizeof(struct vtoc8))
 197                 return (ENXIO);
 198
 199         table = (struct g_part_vtoc8_table *)basetable;
 200
 201         msize = MIN(pp->mediasize / pp->sectorsize, UINT32_MAX);
 202         table->secpercyl = basetable->gpt_sectors * basetable->gpt_heads;
 203         pcyls = msize / table->secpercyl;
 204         acyls = 2;
 205         ncyls = pcyls - acyls;
 206         msize = ncyls * table->secpercyl;
 207
 208         sprintf(table->vtoc.ascii, "FreeBSD%lldM cyl %u alt %u hd %u sec %u",
 209             (long long)(msize / 2048), ncyls, acyls, basetable->gpt_heads,
 210             basetable->gpt_sectors);
 211         be32enc(&table->vtoc.version, VTOC_VERSION);
 212         be16enc(&table->vtoc.nparts, VTOC8_NPARTS);
 213         be32enc(&table->vtoc.sanity, VTOC_SANITY);
 214         be16enc(&table->vtoc.rpm, 3600);
 215         be16enc(&table->vtoc.physcyls, pcyls);
 216         be16enc(&table->vtoc.ncyls, ncyls);
 217         be16enc(&table->vtoc.altcyls, acyls);
 218         be16enc(&table->vtoc.nheads, basetable->gpt_heads);
 219         be16enc(&table->vtoc.nsecs, basetable->gpt_sectors);
 220         be16enc(&table->vtoc.magic, VTOC_MAGIC);
 221
 222         basetable->gpt_first = 0;
 223         basetable->gpt_last = msize - 1;
 224         basetable->gpt_isleaf = 1;
 225
 226         entry = g_part_new_entry(basetable, VTOC_RAW_PART + 1,
 227             basetable->gpt_first, basetable->gpt_last);
 228         entry->gpe_internal = 1;
 229         be16enc(&table->vtoc.part[VTOC_RAW_PART].tag, VTOC_TAG_BACKUP);
 230         be32enc(&table->vtoc.map[VTOC_RAW_PART].nblks, msize);
 231         return (0);
 232 }
 233
 234 static int
 235 g_part_vtoc8_destroy(struct g_part_table *basetable, struct g_part_parms *gpp)
 236 {
 237
 238         /* Wipe the first sector to clear the partitioning. */
 239         basetable->gpt_smhead |= 1;
 240         return (0);
 241 }
 242
 243 static void
 244 g_part_vtoc8_dumpconf(struct g_part_table *basetable,
 245     struct g_part_entry *entry, struct sbuf *sb, const char *indent)
 246 {
 247         struct g_part_vtoc8_table *table;
 248
 249         table = (struct g_part_vtoc8_table *)basetable;
 250         if (indent == NULL) {
 251                 /* conftxt: libdisk compatibility */
 252                 sbuf_printf(sb, " xs SUN sc %u hd %u alt %u",
 253                     be16dec(&table->vtoc.nsecs), be16dec(&table->vtoc.nheads),
 254                     be16dec(&table->vtoc.altcyls));
 255         } else if (entry != NULL) {
 256                 /* confxml: partition entry information */
 257                 sbuf_printf(sb, "%s<rawtype>%u</rawtype>\n", indent,
 258                     be16dec(&table->vtoc.part[entry->gpe_index - 1].tag));
 259         } else {
 260                 /* confxml: scheme information */
 261         }
 262 }
 263
 264 static int
 265 g_part_vtoc8_dumpto(struct g_part_table *basetable,
 266     struct g_part_entry *entry)
 267 {
 268         struct g_part_vtoc8_table *table;
 269         uint16_t tag;
 270
 271         /*
 272          * Allow dumping to a swap partition or a partition that
 273          * has no type.
 274          */
 275         table = (struct g_part_vtoc8_table *)basetable;
 276         tag = be16dec(&table->vtoc.part[entry->gpe_index - 1].tag);
 277         return ((tag == 0 || tag == VTOC_TAG_FREEBSD_SWAP ||
 278             tag == VTOC_TAG_SWAP) ? 1 : 0);
 279 }
 280
 281 static int
 282 g_part_vtoc8_modify(struct g_part_table *basetable,
 283     struct g_part_entry *entry, struct g_part_parms *gpp)
 284 {
 285         struct g_part_vtoc8_table *table;
 286         int error;
 287         uint16_t tag;
 288
 289         if (gpp->gpp_parms & G_PART_PARM_LABEL)
 290                 return (EINVAL);
 291
 292         table = (struct g_part_vtoc8_table *)basetable;
 293         if (gpp->gpp_parms & G_PART_PARM_TYPE) {
 294                 error = vtoc8_parse_type(gpp->gpp_type, &tag);
 295                 if (error)
 296                         return(error);
 297
 298                 be16enc(&table->vtoc.part[entry->gpe_index - 1].tag, tag);
 299         }
 300         return (0);
 301 }
 302
 303 static int
 304 g_part_vtoc8_resize(struct g_part_table *basetable,
 305     struct g_part_entry *entry, struct g_part_parms *gpp)
 306 {
 307         struct g_part_vtoc8_table *table;
 308         uint64_t size;
 309
 310         table = (struct g_part_vtoc8_table *)basetable;
 311         size = gpp->gpp_size;
 312         if (size % table->secpercyl)
 313                 size = size - (size % table->secpercyl);
 314         if (size < table->secpercyl)
 315                 return (EINVAL);
 316
 317         entry->gpe_end = entry->gpe_start + size - 1;
 318         be32enc(&table->vtoc.map[entry->gpe_index - 1].nblks, size);
 319
 320         return (0);
 321 }
 322
 323 static const char *
 324 g_part_vtoc8_name(struct g_part_table *table, struct g_part_entry *baseentry,
 325     char *buf, size_t bufsz)
 326 {
 327
 328         snprintf(buf, bufsz, "%c", 'a' + baseentry->gpe_index - 1);
 329         return (buf);
 330 }
 331
 332 static int
 333 g_part_vtoc8_probe(struct g_part_table *table, struct g_consumer *cp)
 334 {
 335         struct g_provider *pp;
 336         u_char *buf;
 337         int error, ofs, res;
 338         uint16_t cksum, magic;
 339
 340         pp = cp->provider;
 341
 342         /* Sanity-check the provider. */
 343         if (pp->sectorsize != sizeof(struct vtoc8))
 344                 return (ENOSPC);
 345
 346         /* Check that there's a disklabel. */
 347         buf = g_read_data(cp, 0, pp->sectorsize, &error);
 348         if (buf == NULL)
 349                 return (error);
 350
 351         res = ENXIO;    /* Assume mismatch */
 352
 353         /* Check the magic */
 354         magic = be16dec(buf + offsetof(struct vtoc8, magic));
 355         if (magic != VTOC_MAGIC)
 356                 goto out;
 357
 358         /* Check the sum */
 359         cksum = 0;
 360         for (ofs = 0; ofs < sizeof(struct vtoc8); ofs += 2)
 361                 cksum ^= be16dec(buf + ofs);
 362         if (cksum != 0)
 363                 goto out;
 364
 365         res = G_PART_PROBE_PRI_NORM;
 366
 367  out:
 368         g_free(buf);
 369         return (res);
 370 }
 371
 372 static int
 373 g_part_vtoc8_read(struct g_part_table *basetable, struct g_consumer *cp)
 374 {
 375         struct g_provider *pp;
 376         struct g_part_vtoc8_table *table;
 377         struct g_part_entry *entry;
 378         u_char *buf;
 379         off_t chs, msize;
 380         uint64_t offset, size;
 381         u_int cyls, heads, sectors;
 382         int error, index, withtags;
 383         uint16_t tag;
 384
 385         pp = cp->provider;
 386         buf = g_read_data(cp, 0, pp->sectorsize, &error);
 387         if (buf == NULL)
 388                 return (error);
 389
 390         table = (struct g_part_vtoc8_table *)basetable;
 391         bcopy(buf, &table->vtoc, sizeof(table->vtoc));
 392         g_free(buf);
 393
 394         msize = MIN(pp->mediasize / pp->sectorsize, UINT32_MAX);
 395         sectors = be16dec(&table->vtoc.nsecs);
 396         if (sectors < 1)
 397                 goto invalid_label;
 398         if (sectors != basetable->gpt_sectors && !basetable->gpt_fixgeom) {
 399                 g_part_geometry_heads(msize, sectors, &chs, &heads);
 400                 if (chs != 0) {
 401                         basetable->gpt_sectors = sectors;
 402                         basetable->gpt_heads = heads;
 403                 }
 404         }
 405
 406         heads = be16dec(&table->vtoc.nheads);
 407         if (heads < 1)
 408                 goto invalid_label;
 409         if (heads != basetable->gpt_heads && !basetable->gpt_fixgeom)
 410                 basetable->gpt_heads = heads;
 411         /*
 412          * Except for ATA disks > 32GB, Solaris uses the native geometry
 413          * as reported by the target for the labels while da(4) typically
 414          * uses a synthetic one so we don't complain too loudly if these
 415          * geometries don't match.
 416          */
 417         if (bootverbose && (sectors != basetable->gpt_sectors ||
 418             heads != basetable->gpt_heads))
 419                 printf("GEOM: %s: geometry does not match VTOC8 label "
 420                     "(label: %uh,%us GEOM: %uh,%us).\n", pp->name, heads,
 421                     sectors, basetable->gpt_heads, basetable->gpt_sectors);
 422
 423         table->secpercyl = heads * sectors;
 424         cyls = be16dec(&table->vtoc.ncyls);
 425         chs = cyls * table->secpercyl;
 426         if (chs < 1 || chs > msize)
 427                 goto invalid_label;
 428
 429         basetable->gpt_first = 0;
 430         basetable->gpt_last = chs - 1;
 431         basetable->gpt_isleaf = 1;
 432
 433         withtags = (be32dec(&table->vtoc.sanity) == VTOC_SANITY) ? 1 : 0;
 434         if (!withtags) {
 435                 printf("GEOM: %s: adding VTOC8 information.\n", pp->name);
 436                 be32enc(&table->vtoc.version, VTOC_VERSION);
 437                 bzero(&table->vtoc.volume, VTOC_VOLUME_LEN);
 438                 be16enc(&table->vtoc.nparts, VTOC8_NPARTS);
 439                 bzero(&table->vtoc.part, sizeof(table->vtoc.part));
 440                 be32enc(&table->vtoc.sanity, VTOC_SANITY);
 441         }
 442
 443         basetable->gpt_entries = be16dec(&table->vtoc.nparts);
 444         if (basetable->gpt_entries < g_part_vtoc8_scheme.gps_minent ||
 445             basetable->gpt_entries > g_part_vtoc8_scheme.gps_maxent)
 446                 goto invalid_label;
 447
 448         for (index = basetable->gpt_entries - 1; index >= 0; index--) {
 449                 offset = be32dec(&table->vtoc.map[index].cyl) *
 450                     table->secpercyl;
 451                 size = be32dec(&table->vtoc.map[index].nblks);
 452                 if (size == 0)
 453                         continue;
 454                 if (withtags)
 455                         tag = be16dec(&table->vtoc.part[index].tag);
 456                 else
 457                         tag = (index == VTOC_RAW_PART)
 458                             ? VTOC_TAG_BACKUP
 459                             : VTOC_TAG_UNASSIGNED;
 460
 461                 if (index == VTOC_RAW_PART && tag != VTOC_TAG_BACKUP)
 462                         continue;
 463                 if (index != VTOC_RAW_PART && tag == VTOC_TAG_BACKUP)
 464                         continue;
 465                 entry = g_part_new_entry(basetable, index + 1, offset,
 466                     offset + size - 1);
 467                 if (tag == VTOC_TAG_BACKUP)
 468                         entry->gpe_internal = 1;
 469
 470                 if (!withtags)
 471                         be16enc(&table->vtoc.part[index].tag, tag);
 472         }
 473
 474         return (0);
 475
 476  invalid_label:
 477         printf("GEOM: %s: invalid VTOC8 label.\n", pp->name);
 478         return (EINVAL);
 479 }
 480
 481 static const char *
 482 g_part_vtoc8_type(struct g_part_table *basetable, struct g_part_entry *entry,
 483     char *buf, size_t bufsz)
 484 {
 485         struct g_part_vtoc8_table *table;
 486         uint16_t tag;
 487
 488         table = (struct g_part_vtoc8_table *)basetable;
 489         tag = be16dec(&table->vtoc.part[entry->gpe_index - 1].tag);
 490         if (tag == VTOC_TAG_FREEBSD_SWAP)
 491                 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_SWAP));
 492         if (tag == VTOC_TAG_FREEBSD_UFS)
 493                 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_UFS));
 494         if (tag == VTOC_TAG_FREEBSD_VINUM)
 495                 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_VINUM));
 496         if (tag == VTOC_TAG_FREEBSD_ZFS)
 497                 return (g_part_alias_name(G_PART_ALIAS_FREEBSD_ZFS));
 498         snprintf(buf, bufsz, "!%d", tag);
 499         return (buf);
 500 }
 501
 502 static int
 503 g_part_vtoc8_write(struct g_part_table *basetable, struct g_consumer *cp)
 504 {
 505         struct g_provider *pp;
 506         struct g_part_entry *entry;
 507         struct g_part_vtoc8_table *table;
 508         uint16_t sum;
 509         u_char *p;
 510         int error, index, match, offset;
 511
 512         pp = cp->provider;
 513         table = (struct g_part_vtoc8_table *)basetable;
 514         entry = LIST_FIRST(&basetable->gpt_entry);
 515         for (index = 0; index < basetable->gpt_entries; index++) {
 516                 match = (entry != NULL && index == entry->gpe_index - 1)
 517                     ? 1 : 0;
 518                 if (match) {
 519                         if (entry->gpe_deleted) {
 520                                 be16enc(&table->vtoc.part[index].tag, 0);
 521                                 be16enc(&table->vtoc.part[index].flag, 0);
 522                                 be32enc(&table->vtoc.map[index].cyl, 0);
 523                                 be32enc(&table->vtoc.map[index].nblks, 0);
 524                         }
 525                         entry = LIST_NEXT(entry, gpe_entry);
 526                 }
 527         }
 528
 529         /* Calculate checksum. */
 530         sum = 0;
 531         p = (void *)&table->vtoc;
 532         for (offset = 0; offset < sizeof(table->vtoc) - 2; offset += 2)
 533                 sum ^= be16dec(p + offset);
 534         be16enc(&table->vtoc.cksum, sum);
 535
 536         error = g_write_data(cp, 0, p, pp->sectorsize);
 537         return (error);
 538 }