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