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