linux/fs/partitions/ldm.c
<<
>>
Prefs
   1/**
   2 * ldm - Support for Windows Logical Disk Manager (Dynamic Disks)
   3 *
   4 * Copyright (C) 2001,2002 Richard Russon <ldm@flatcap.org>
   5 * Copyright (c) 2001-2007 Anton Altaparmakov
   6 * Copyright (C) 2001,2002 Jakob Kemi <jakob.kemi@telia.com>
   7 *
   8 * Documentation is available at http://www.linux-ntfs.org/doku.php?id=downloads 
   9 *
  10 * This program is free software; you can redistribute it and/or modify it under
  11 * the terms of the GNU General Public License as published by the Free Software
  12 * Foundation; either version 2 of the License, or (at your option) any later
  13 * version.
  14 *
  15 * This program is distributed in the hope that it will be useful, but WITHOUT
  16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18 * details.
  19 *
  20 * You should have received a copy of the GNU General Public License along with
  21 * this program (in the main directory of the source in the file COPYING); if
  22 * not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  23 * Boston, MA  02111-1307  USA
  24 */
  25
  26#include <linux/slab.h>
  27#include <linux/pagemap.h>
  28#include <linux/stringify.h>
  29#include <linux/kernel.h>
  30#include "ldm.h"
  31#include "check.h"
  32#include "msdos.h"
  33
  34/**
  35 * ldm_debug/info/error/crit - Output an error message
  36 * @f:    A printf format string containing the message
  37 * @...:  Variables to substitute into @f
  38 *
  39 * ldm_debug() writes a DEBUG level message to the syslog but only if the
  40 * driver was compiled with debug enabled. Otherwise, the call turns into a NOP.
  41 */
  42#ifndef CONFIG_LDM_DEBUG
  43#define ldm_debug(...)  do {} while (0)
  44#else
  45#define ldm_debug(f, a...) _ldm_printk (KERN_DEBUG, __func__, f, ##a)
  46#endif
  47
  48#define ldm_crit(f, a...)  _ldm_printk (KERN_CRIT,  __func__, f, ##a)
  49#define ldm_error(f, a...) _ldm_printk (KERN_ERR,   __func__, f, ##a)
  50#define ldm_info(f, a...)  _ldm_printk (KERN_INFO,  __func__, f, ##a)
  51
  52__attribute__ ((format (printf, 3, 4)))
  53static void _ldm_printk (const char *level, const char *function,
  54                         const char *fmt, ...)
  55{
  56        static char buf[128];
  57        va_list args;
  58
  59        va_start (args, fmt);
  60        vsnprintf (buf, sizeof (buf), fmt, args);
  61        va_end (args);
  62
  63        printk ("%s%s(): %s\n", level, function, buf);
  64}
  65
  66/**
  67 * ldm_parse_hexbyte - Convert a ASCII hex number to a byte
  68 * @src:  Pointer to at least 2 characters to convert.
  69 *
  70 * Convert a two character ASCII hex string to a number.
  71 *
  72 * Return:  0-255  Success, the byte was parsed correctly
  73 *          -1     Error, an invalid character was supplied
  74 */
  75static int ldm_parse_hexbyte (const u8 *src)
  76{
  77        unsigned int x;         /* For correct wrapping */
  78        int h;
  79
  80        /* high part */
  81        x = h = hex_to_bin(src[0]);
  82        if (h < 0)
  83                return -1;
  84
  85        /* low part */
  86        h = hex_to_bin(src[1]);
  87        if (h < 0)
  88                return -1;
  89
  90        return (x << 4) + h;
  91}
  92
  93/**
  94 * ldm_parse_guid - Convert GUID from ASCII to binary
  95 * @src:   36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
  96 * @dest:  Memory block to hold binary GUID (16 bytes)
  97 *
  98 * N.B. The GUID need not be NULL terminated.
  99 *
 100 * Return:  'true'   @dest contains binary GUID
 101 *          'false'  @dest contents are undefined
 102 */
 103static bool ldm_parse_guid (const u8 *src, u8 *dest)
 104{
 105        static const int size[] = { 4, 2, 2, 2, 6 };
 106        int i, j, v;
 107
 108        if (src[8]  != '-' || src[13] != '-' ||
 109            src[18] != '-' || src[23] != '-')
 110                return false;
 111
 112        for (j = 0; j < 5; j++, src++)
 113                for (i = 0; i < size[j]; i++, src+=2, *dest++ = v)
 114                        if ((v = ldm_parse_hexbyte (src)) < 0)
 115                                return false;
 116
 117        return true;
 118}
 119
 120/**
 121 * ldm_parse_privhead - Read the LDM Database PRIVHEAD structure
 122 * @data:  Raw database PRIVHEAD structure loaded from the device
 123 * @ph:    In-memory privhead structure in which to return parsed information
 124 *
 125 * This parses the LDM database PRIVHEAD structure supplied in @data and
 126 * sets up the in-memory privhead structure @ph with the obtained information.
 127 *
 128 * Return:  'true'   @ph contains the PRIVHEAD data
 129 *          'false'  @ph contents are undefined
 130 */
 131static bool ldm_parse_privhead(const u8 *data, struct privhead *ph)
 132{
 133        bool is_vista = false;
 134
 135        BUG_ON(!data || !ph);
 136        if (MAGIC_PRIVHEAD != get_unaligned_be64(data)) {
 137                ldm_error("Cannot find PRIVHEAD structure. LDM database is"
 138                        " corrupt. Aborting.");
 139                return false;
 140        }
 141        ph->ver_major = get_unaligned_be16(data + 0x000C);
 142        ph->ver_minor = get_unaligned_be16(data + 0x000E);
 143        ph->logical_disk_start = get_unaligned_be64(data + 0x011B);
 144        ph->logical_disk_size = get_unaligned_be64(data + 0x0123);
 145        ph->config_start = get_unaligned_be64(data + 0x012B);
 146        ph->config_size = get_unaligned_be64(data + 0x0133);
 147        /* Version 2.11 is Win2k/XP and version 2.12 is Vista. */
 148        if (ph->ver_major == 2 && ph->ver_minor == 12)
 149                is_vista = true;
 150        if (!is_vista && (ph->ver_major != 2 || ph->ver_minor != 11)) {
 151                ldm_error("Expected PRIVHEAD version 2.11 or 2.12, got %d.%d."
 152                        " Aborting.", ph->ver_major, ph->ver_minor);
 153                return false;
 154        }
 155        ldm_debug("PRIVHEAD version %d.%d (Windows %s).", ph->ver_major,
 156                        ph->ver_minor, is_vista ? "Vista" : "2000/XP");
 157        if (ph->config_size != LDM_DB_SIZE) {   /* 1 MiB in sectors. */
 158                /* Warn the user and continue, carefully. */
 159                ldm_info("Database is normally %u bytes, it claims to "
 160                        "be %llu bytes.", LDM_DB_SIZE,
 161                        (unsigned long long)ph->config_size);
 162        }
 163        if ((ph->logical_disk_size == 0) || (ph->logical_disk_start +
 164                        ph->logical_disk_size > ph->config_start)) {
 165                ldm_error("PRIVHEAD disk size doesn't match real disk size");
 166                return false;
 167        }
 168        if (!ldm_parse_guid(data + 0x0030, ph->disk_id)) {
 169                ldm_error("PRIVHEAD contains an invalid GUID.");
 170                return false;
 171        }
 172        ldm_debug("Parsed PRIVHEAD successfully.");
 173        return true;
 174}
 175
 176/**
 177 * ldm_parse_tocblock - Read the LDM Database TOCBLOCK structure
 178 * @data:  Raw database TOCBLOCK structure loaded from the device
 179 * @toc:   In-memory toc structure in which to return parsed information
 180 *
 181 * This parses the LDM Database TOCBLOCK (table of contents) structure supplied
 182 * in @data and sets up the in-memory tocblock structure @toc with the obtained
 183 * information.
 184 *
 185 * N.B.  The *_start and *_size values returned in @toc are not range-checked.
 186 *
 187 * Return:  'true'   @toc contains the TOCBLOCK data
 188 *          'false'  @toc contents are undefined
 189 */
 190static bool ldm_parse_tocblock (const u8 *data, struct tocblock *toc)
 191{
 192        BUG_ON (!data || !toc);
 193
 194        if (MAGIC_TOCBLOCK != get_unaligned_be64(data)) {
 195                ldm_crit ("Cannot find TOCBLOCK, database may be corrupt.");
 196                return false;
 197        }
 198        strncpy (toc->bitmap1_name, data + 0x24, sizeof (toc->bitmap1_name));
 199        toc->bitmap1_name[sizeof (toc->bitmap1_name) - 1] = 0;
 200        toc->bitmap1_start = get_unaligned_be64(data + 0x2E);
 201        toc->bitmap1_size  = get_unaligned_be64(data + 0x36);
 202
 203        if (strncmp (toc->bitmap1_name, TOC_BITMAP1,
 204                        sizeof (toc->bitmap1_name)) != 0) {
 205                ldm_crit ("TOCBLOCK's first bitmap is '%s', should be '%s'.",
 206                                TOC_BITMAP1, toc->bitmap1_name);
 207                return false;
 208        }
 209        strncpy (toc->bitmap2_name, data + 0x46, sizeof (toc->bitmap2_name));
 210        toc->bitmap2_name[sizeof (toc->bitmap2_name) - 1] = 0;
 211        toc->bitmap2_start = get_unaligned_be64(data + 0x50);
 212        toc->bitmap2_size  = get_unaligned_be64(data + 0x58);
 213        if (strncmp (toc->bitmap2_name, TOC_BITMAP2,
 214                        sizeof (toc->bitmap2_name)) != 0) {
 215                ldm_crit ("TOCBLOCK's second bitmap is '%s', should be '%s'.",
 216                                TOC_BITMAP2, toc->bitmap2_name);
 217                return false;
 218        }
 219        ldm_debug ("Parsed TOCBLOCK successfully.");
 220        return true;
 221}
 222
 223/**
 224 * ldm_parse_vmdb - Read the LDM Database VMDB structure
 225 * @data:  Raw database VMDB structure loaded from the device
 226 * @vm:    In-memory vmdb structure in which to return parsed information
 227 *
 228 * This parses the LDM Database VMDB structure supplied in @data and sets up
 229 * the in-memory vmdb structure @vm with the obtained information.
 230 *
 231 * N.B.  The *_start, *_size and *_seq values will be range-checked later.
 232 *
 233 * Return:  'true'   @vm contains VMDB info
 234 *          'false'  @vm contents are undefined
 235 */
 236static bool ldm_parse_vmdb (const u8 *data, struct vmdb *vm)
 237{
 238        BUG_ON (!data || !vm);
 239
 240        if (MAGIC_VMDB != get_unaligned_be32(data)) {
 241                ldm_crit ("Cannot find the VMDB, database may be corrupt.");
 242                return false;
 243        }
 244
 245        vm->ver_major = get_unaligned_be16(data + 0x12);
 246        vm->ver_minor = get_unaligned_be16(data + 0x14);
 247        if ((vm->ver_major != 4) || (vm->ver_minor != 10)) {
 248                ldm_error ("Expected VMDB version %d.%d, got %d.%d. "
 249                        "Aborting.", 4, 10, vm->ver_major, vm->ver_minor);
 250                return false;
 251        }
 252
 253        vm->vblk_size     = get_unaligned_be32(data + 0x08);
 254        if (vm->vblk_size == 0) {
 255                ldm_error ("Illegal VBLK size");
 256                return false;
 257        }
 258
 259        vm->vblk_offset   = get_unaligned_be32(data + 0x0C);
 260        vm->last_vblk_seq = get_unaligned_be32(data + 0x04);
 261
 262        ldm_debug ("Parsed VMDB successfully.");
 263        return true;
 264}
 265
 266/**
 267 * ldm_compare_privheads - Compare two privhead objects
 268 * @ph1:  First privhead
 269 * @ph2:  Second privhead
 270 *
 271 * This compares the two privhead structures @ph1 and @ph2.
 272 *
 273 * Return:  'true'   Identical
 274 *          'false'  Different
 275 */
 276static bool ldm_compare_privheads (const struct privhead *ph1,
 277                                   const struct privhead *ph2)
 278{
 279        BUG_ON (!ph1 || !ph2);
 280
 281        return ((ph1->ver_major          == ph2->ver_major)             &&
 282                (ph1->ver_minor          == ph2->ver_minor)             &&
 283                (ph1->logical_disk_start == ph2->logical_disk_start)    &&
 284                (ph1->logical_disk_size  == ph2->logical_disk_size)     &&
 285                (ph1->config_start       == ph2->config_start)          &&
 286                (ph1->config_size        == ph2->config_size)           &&
 287                !memcmp (ph1->disk_id, ph2->disk_id, GUID_SIZE));
 288}
 289
 290/**
 291 * ldm_compare_tocblocks - Compare two tocblock objects
 292 * @toc1:  First toc
 293 * @toc2:  Second toc
 294 *
 295 * This compares the two tocblock structures @toc1 and @toc2.
 296 *
 297 * Return:  'true'   Identical
 298 *          'false'  Different
 299 */
 300static bool ldm_compare_tocblocks (const struct tocblock *toc1,
 301                                   const struct tocblock *toc2)
 302{
 303        BUG_ON (!toc1 || !toc2);
 304
 305        return ((toc1->bitmap1_start == toc2->bitmap1_start)    &&
 306                (toc1->bitmap1_size  == toc2->bitmap1_size)     &&
 307                (toc1->bitmap2_start == toc2->bitmap2_start)    &&
 308                (toc1->bitmap2_size  == toc2->bitmap2_size)     &&
 309                !strncmp (toc1->bitmap1_name, toc2->bitmap1_name,
 310                        sizeof (toc1->bitmap1_name))            &&
 311                !strncmp (toc1->bitmap2_name, toc2->bitmap2_name,
 312                        sizeof (toc1->bitmap2_name)));
 313}
 314
 315/**
 316 * ldm_validate_privheads - Compare the primary privhead with its backups
 317 * @state: Partition check state including device holding the LDM Database
 318 * @ph1:   Memory struct to fill with ph contents
 319 *
 320 * Read and compare all three privheads from disk.
 321 *
 322 * The privheads on disk show the size and location of the main disk area and
 323 * the configuration area (the database).  The values are range-checked against
 324 * @hd, which contains the real size of the disk.
 325 *
 326 * Return:  'true'   Success
 327 *          'false'  Error
 328 */
 329static bool ldm_validate_privheads(struct parsed_partitions *state,
 330                                   struct privhead *ph1)
 331{
 332        static const int off[3] = { OFF_PRIV1, OFF_PRIV2, OFF_PRIV3 };
 333        struct privhead *ph[3] = { ph1 };
 334        Sector sect;
 335        u8 *data;
 336        bool result = false;
 337        long num_sects;
 338        int i;
 339
 340        BUG_ON (!state || !ph1);
 341
 342        ph[1] = kmalloc (sizeof (*ph[1]), GFP_KERNEL);
 343        ph[2] = kmalloc (sizeof (*ph[2]), GFP_KERNEL);
 344        if (!ph[1] || !ph[2]) {
 345                ldm_crit ("Out of memory.");
 346                goto out;
 347        }
 348
 349        /* off[1 & 2] are relative to ph[0]->config_start */
 350        ph[0]->config_start = 0;
 351
 352        /* Read and parse privheads */
 353        for (i = 0; i < 3; i++) {
 354                data = read_part_sector(state, ph[0]->config_start + off[i],
 355                                        &sect);
 356                if (!data) {
 357                        ldm_crit ("Disk read failed.");
 358                        goto out;
 359                }
 360                result = ldm_parse_privhead (data, ph[i]);
 361                put_dev_sector (sect);
 362                if (!result) {
 363                        ldm_error ("Cannot find PRIVHEAD %d.", i+1); /* Log again */
 364                        if (i < 2)
 365                                goto out;       /* Already logged */
 366                        else
 367                                break;  /* FIXME ignore for now, 3rd PH can fail on odd-sized disks */
 368                }
 369        }
 370
 371        num_sects = state->bdev->bd_inode->i_size >> 9;
 372
 373        if ((ph[0]->config_start > num_sects) ||
 374           ((ph[0]->config_start + ph[0]->config_size) > num_sects)) {
 375                ldm_crit ("Database extends beyond the end of the disk.");
 376                goto out;
 377        }
 378
 379        if ((ph[0]->logical_disk_start > ph[0]->config_start) ||
 380           ((ph[0]->logical_disk_start + ph[0]->logical_disk_size)
 381                    > ph[0]->config_start)) {
 382                ldm_crit ("Disk and database overlap.");
 383                goto out;
 384        }
 385
 386        if (!ldm_compare_privheads (ph[0], ph[1])) {
 387                ldm_crit ("Primary and backup PRIVHEADs don't match.");
 388                goto out;
 389        }
 390        /* FIXME ignore this for now
 391        if (!ldm_compare_privheads (ph[0], ph[2])) {
 392                ldm_crit ("Primary and backup PRIVHEADs don't match.");
 393                goto out;
 394        }*/
 395        ldm_debug ("Validated PRIVHEADs successfully.");
 396        result = true;
 397out:
 398        kfree (ph[1]);
 399        kfree (ph[2]);
 400        return result;
 401}
 402
 403/**
 404 * ldm_validate_tocblocks - Validate the table of contents and its backups
 405 * @state: Partition check state including device holding the LDM Database
 406 * @base:  Offset, into @state->bdev, of the database
 407 * @ldb:   Cache of the database structures
 408 *
 409 * Find and compare the four tables of contents of the LDM Database stored on
 410 * @state->bdev and return the parsed information into @toc1.
 411 *
 412 * The offsets and sizes of the configs are range-checked against a privhead.
 413 *
 414 * Return:  'true'   @toc1 contains validated TOCBLOCK info
 415 *          'false'  @toc1 contents are undefined
 416 */
 417static bool ldm_validate_tocblocks(struct parsed_partitions *state,
 418                                   unsigned long base, struct ldmdb *ldb)
 419{
 420        static const int off[4] = { OFF_TOCB1, OFF_TOCB2, OFF_TOCB3, OFF_TOCB4};
 421        struct tocblock *tb[4];
 422        struct privhead *ph;
 423        Sector sect;
 424        u8 *data;
 425        int i, nr_tbs;
 426        bool result = false;
 427
 428        BUG_ON(!state || !ldb);
 429        ph = &ldb->ph;
 430        tb[0] = &ldb->toc;
 431        tb[1] = kmalloc(sizeof(*tb[1]) * 3, GFP_KERNEL);
 432        if (!tb[1]) {
 433                ldm_crit("Out of memory.");
 434                goto err;
 435        }
 436        tb[2] = (struct tocblock*)((u8*)tb[1] + sizeof(*tb[1]));
 437        tb[3] = (struct tocblock*)((u8*)tb[2] + sizeof(*tb[2]));
 438        /*
 439         * Try to read and parse all four TOCBLOCKs.
 440         *
 441         * Windows Vista LDM v2.12 does not always have all four TOCBLOCKs so
 442         * skip any that fail as long as we get at least one valid TOCBLOCK.
 443         */
 444        for (nr_tbs = i = 0; i < 4; i++) {
 445                data = read_part_sector(state, base + off[i], &sect);
 446                if (!data) {
 447                        ldm_error("Disk read failed for TOCBLOCK %d.", i);
 448                        continue;
 449                }
 450                if (ldm_parse_tocblock(data, tb[nr_tbs]))
 451                        nr_tbs++;
 452                put_dev_sector(sect);
 453        }
 454        if (!nr_tbs) {
 455                ldm_crit("Failed to find a valid TOCBLOCK.");
 456                goto err;
 457        }
 458        /* Range check the TOCBLOCK against a privhead. */
 459        if (((tb[0]->bitmap1_start + tb[0]->bitmap1_size) > ph->config_size) ||
 460                        ((tb[0]->bitmap2_start + tb[0]->bitmap2_size) >
 461                        ph->config_size)) {
 462                ldm_crit("The bitmaps are out of range.  Giving up.");
 463                goto err;
 464        }
 465        /* Compare all loaded TOCBLOCKs. */
 466        for (i = 1; i < nr_tbs; i++) {
 467                if (!ldm_compare_tocblocks(tb[0], tb[i])) {
 468                        ldm_crit("TOCBLOCKs 0 and %d do not match.", i);
 469                        goto err;
 470                }
 471        }
 472        ldm_debug("Validated %d TOCBLOCKs successfully.", nr_tbs);
 473        result = true;
 474err:
 475        kfree(tb[1]);
 476        return result;
 477}
 478
 479/**
 480 * ldm_validate_vmdb - Read the VMDB and validate it
 481 * @state: Partition check state including device holding the LDM Database
 482 * @base:  Offset, into @bdev, of the database
 483 * @ldb:   Cache of the database structures
 484 *
 485 * Find the vmdb of the LDM Database stored on @bdev and return the parsed
 486 * information in @ldb.
 487 *
 488 * Return:  'true'   @ldb contains validated VBDB info
 489 *          'false'  @ldb contents are undefined
 490 */
 491static bool ldm_validate_vmdb(struct parsed_partitions *state,
 492                              unsigned long base, struct ldmdb *ldb)
 493{
 494        Sector sect;
 495        u8 *data;
 496        bool result = false;
 497        struct vmdb *vm;
 498        struct tocblock *toc;
 499
 500        BUG_ON (!state || !ldb);
 501
 502        vm  = &ldb->vm;
 503        toc = &ldb->toc;
 504
 505        data = read_part_sector(state, base + OFF_VMDB, &sect);
 506        if (!data) {
 507                ldm_crit ("Disk read failed.");
 508                return false;
 509        }
 510
 511        if (!ldm_parse_vmdb (data, vm))
 512                goto out;                               /* Already logged */
 513
 514        /* Are there uncommitted transactions? */
 515        if (get_unaligned_be16(data + 0x10) != 0x01) {
 516                ldm_crit ("Database is not in a consistent state.  Aborting.");
 517                goto out;
 518        }
 519
 520        if (vm->vblk_offset != 512)
 521                ldm_info ("VBLKs start at offset 0x%04x.", vm->vblk_offset);
 522
 523        /*
 524         * The last_vblkd_seq can be before the end of the vmdb, just make sure
 525         * it is not out of bounds.
 526         */
 527        if ((vm->vblk_size * vm->last_vblk_seq) > (toc->bitmap1_size << 9)) {
 528                ldm_crit ("VMDB exceeds allowed size specified by TOCBLOCK.  "
 529                                "Database is corrupt.  Aborting.");
 530                goto out;
 531        }
 532
 533        result = true;
 534out:
 535        put_dev_sector (sect);
 536        return result;
 537}
 538
 539
 540/**
 541 * ldm_validate_partition_table - Determine whether bdev might be a dynamic disk
 542 * @state: Partition check state including device holding the LDM Database
 543 *
 544 * This function provides a weak test to decide whether the device is a dynamic
 545 * disk or not.  It looks for an MS-DOS-style partition table containing at
 546 * least one partition of type 0x42 (formerly SFS, now used by Windows for
 547 * dynamic disks).
 548 *
 549 * N.B.  The only possible error can come from the read_part_sector and that is
 550 *       only likely to happen if the underlying device is strange.  If that IS
 551 *       the case we should return zero to let someone else try.
 552 *
 553 * Return:  'true'   @state->bdev is a dynamic disk
 554 *          'false'  @state->bdev is not a dynamic disk, or an error occurred
 555 */
 556static bool ldm_validate_partition_table(struct parsed_partitions *state)
 557{
 558        Sector sect;
 559        u8 *data;
 560        struct partition *p;
 561        int i;
 562        bool result = false;
 563
 564        BUG_ON(!state);
 565
 566        data = read_part_sector(state, 0, &sect);
 567        if (!data) {
 568                ldm_crit ("Disk read failed.");
 569                return false;
 570        }
 571
 572        if (*(__le16*) (data + 0x01FE) != cpu_to_le16 (MSDOS_LABEL_MAGIC))
 573                goto out;
 574
 575        p = (struct partition*)(data + 0x01BE);
 576        for (i = 0; i < 4; i++, p++)
 577                if (SYS_IND (p) == LDM_PARTITION) {
 578                        result = true;
 579                        break;
 580                }
 581
 582        if (result)
 583                ldm_debug ("Found W2K dynamic disk partition type.");
 584
 585out:
 586        put_dev_sector (sect);
 587        return result;
 588}
 589
 590/**
 591 * ldm_get_disk_objid - Search a linked list of vblk's for a given Disk Id
 592 * @ldb:  Cache of the database structures
 593 *
 594 * The LDM Database contains a list of all partitions on all dynamic disks.
 595 * The primary PRIVHEAD, at the beginning of the physical disk, tells us
 596 * the GUID of this disk.  This function searches for the GUID in a linked
 597 * list of vblk's.
 598 *
 599 * Return:  Pointer, A matching vblk was found
 600 *          NULL,    No match, or an error
 601 */
 602static struct vblk * ldm_get_disk_objid (const struct ldmdb *ldb)
 603{
 604        struct list_head *item;
 605
 606        BUG_ON (!ldb);
 607
 608        list_for_each (item, &ldb->v_disk) {
 609                struct vblk *v = list_entry (item, struct vblk, list);
 610                if (!memcmp (v->vblk.disk.disk_id, ldb->ph.disk_id, GUID_SIZE))
 611                        return v;
 612        }
 613
 614        return NULL;
 615}
 616
 617/**
 618 * ldm_create_data_partitions - Create data partitions for this device
 619 * @pp:   List of the partitions parsed so far
 620 * @ldb:  Cache of the database structures
 621 *
 622 * The database contains ALL the partitions for ALL disk groups, so we need to
 623 * filter out this specific disk. Using the disk's object id, we can find all
 624 * the partitions in the database that belong to this disk.
 625 *
 626 * Add each partition in our database, to the parsed_partitions structure.
 627 *
 628 * N.B.  This function creates the partitions in the order it finds partition
 629 *       objects in the linked list.
 630 *
 631 * Return:  'true'   Partition created
 632 *          'false'  Error, probably a range checking problem
 633 */
 634static bool ldm_create_data_partitions (struct parsed_partitions *pp,
 635                                        const struct ldmdb *ldb)
 636{
 637        struct list_head *item;
 638        struct vblk *vb;
 639        struct vblk *disk;
 640        struct vblk_part *part;
 641        int part_num = 1;
 642
 643        BUG_ON (!pp || !ldb);
 644
 645        disk = ldm_get_disk_objid (ldb);
 646        if (!disk) {
 647                ldm_crit ("Can't find the ID of this disk in the database.");
 648                return false;
 649        }
 650
 651        strlcat(pp->pp_buf, " [LDM]", PAGE_SIZE);
 652
 653        /* Create the data partitions */
 654        list_for_each (item, &ldb->v_part) {
 655                vb = list_entry (item, struct vblk, list);
 656                part = &vb->vblk.part;
 657
 658                if (part->disk_id != disk->obj_id)
 659                        continue;
 660
 661                put_partition (pp, part_num, ldb->ph.logical_disk_start +
 662                                part->start, part->size);
 663                part_num++;
 664        }
 665
 666        strlcat(pp->pp_buf, "\n", PAGE_SIZE);
 667        return true;
 668}
 669
 670
 671/**
 672 * ldm_relative - Calculate the next relative offset
 673 * @buffer:  Block of data being worked on
 674 * @buflen:  Size of the block of data
 675 * @base:    Size of the previous fixed width fields
 676 * @offset:  Cumulative size of the previous variable-width fields
 677 *
 678 * Because many of the VBLK fields are variable-width, it's necessary
 679 * to calculate each offset based on the previous one and the length
 680 * of the field it pointed to.
 681 *
 682 * Return:  -1 Error, the calculated offset exceeded the size of the buffer
 683 *           n OK, a range-checked offset into buffer
 684 */
 685static int ldm_relative(const u8 *buffer, int buflen, int base, int offset)
 686{
 687
 688        base += offset;
 689        if (!buffer || offset < 0 || base > buflen) {
 690                if (!buffer)
 691                        ldm_error("!buffer");
 692                if (offset < 0)
 693                        ldm_error("offset (%d) < 0", offset);
 694                if (base > buflen)
 695                        ldm_error("base (%d) > buflen (%d)", base, buflen);
 696                return -1;
 697        }
 698        if (base + buffer[base] >= buflen) {
 699                ldm_error("base (%d) + buffer[base] (%d) >= buflen (%d)", base,
 700                                buffer[base], buflen);
 701                return -1;
 702        }
 703        return buffer[base] + offset + 1;
 704}
 705
 706/**
 707 * ldm_get_vnum - Convert a variable-width, big endian number, into cpu order
 708 * @block:  Pointer to the variable-width number to convert
 709 *
 710 * Large numbers in the LDM Database are often stored in a packed format.  Each
 711 * number is prefixed by a one byte width marker.  All numbers in the database
 712 * are stored in big-endian byte order.  This function reads one of these
 713 * numbers and returns the result
 714 *
 715 * N.B.  This function DOES NOT perform any range checking, though the most
 716 *       it will read is eight bytes.
 717 *
 718 * Return:  n A number
 719 *          0 Zero, or an error occurred
 720 */
 721static u64 ldm_get_vnum (const u8 *block)
 722{
 723        u64 tmp = 0;
 724        u8 length;
 725
 726        BUG_ON (!block);
 727
 728        length = *block++;
 729
 730        if (length && length <= 8)
 731                while (length--)
 732                        tmp = (tmp << 8) | *block++;
 733        else
 734                ldm_error ("Illegal length %d.", length);
 735
 736        return tmp;
 737}
 738
 739/**
 740 * ldm_get_vstr - Read a length-prefixed string into a buffer
 741 * @block:   Pointer to the length marker
 742 * @buffer:  Location to copy string to
 743 * @buflen:  Size of the output buffer
 744 *
 745 * Many of the strings in the LDM Database are not NULL terminated.  Instead
 746 * they are prefixed by a one byte length marker.  This function copies one of
 747 * these strings into a buffer.
 748 *
 749 * N.B.  This function DOES NOT perform any range checking on the input.
 750 *       If the buffer is too small, the output will be truncated.
 751 *
 752 * Return:  0, Error and @buffer contents are undefined
 753 *          n, String length in characters (excluding NULL)
 754 *          buflen-1, String was truncated.
 755 */
 756static int ldm_get_vstr (const u8 *block, u8 *buffer, int buflen)
 757{
 758        int length;
 759
 760        BUG_ON (!block || !buffer);
 761
 762        length = block[0];
 763        if (length >= buflen) {
 764                ldm_error ("Truncating string %d -> %d.", length, buflen);
 765                length = buflen - 1;
 766        }
 767        memcpy (buffer, block + 1, length);
 768        buffer[length] = 0;
 769        return length;
 770}
 771
 772
 773/**
 774 * ldm_parse_cmp3 - Read a raw VBLK Component object into a vblk structure
 775 * @buffer:  Block of data being worked on
 776 * @buflen:  Size of the block of data
 777 * @vb:      In-memory vblk in which to return information
 778 *
 779 * Read a raw VBLK Component object (version 3) into a vblk structure.
 780 *
 781 * Return:  'true'   @vb contains a Component VBLK
 782 *          'false'  @vb contents are not defined
 783 */
 784static bool ldm_parse_cmp3 (const u8 *buffer, int buflen, struct vblk *vb)
 785{
 786        int r_objid, r_name, r_vstate, r_child, r_parent, r_stripe, r_cols, len;
 787        struct vblk_comp *comp;
 788
 789        BUG_ON (!buffer || !vb);
 790
 791        r_objid  = ldm_relative (buffer, buflen, 0x18, 0);
 792        r_name   = ldm_relative (buffer, buflen, 0x18, r_objid);
 793        r_vstate = ldm_relative (buffer, buflen, 0x18, r_name);
 794        r_child  = ldm_relative (buffer, buflen, 0x1D, r_vstate);
 795        r_parent = ldm_relative (buffer, buflen, 0x2D, r_child);
 796
 797        if (buffer[0x12] & VBLK_FLAG_COMP_STRIPE) {
 798                r_stripe = ldm_relative (buffer, buflen, 0x2E, r_parent);
 799                r_cols   = ldm_relative (buffer, buflen, 0x2E, r_stripe);
 800                len = r_cols;
 801        } else {
 802                r_stripe = 0;
 803                r_cols   = 0;
 804                len = r_parent;
 805        }
 806        if (len < 0)
 807                return false;
 808
 809        len += VBLK_SIZE_CMP3;
 810        if (len != get_unaligned_be32(buffer + 0x14))
 811                return false;
 812
 813        comp = &vb->vblk.comp;
 814        ldm_get_vstr (buffer + 0x18 + r_name, comp->state,
 815                sizeof (comp->state));
 816        comp->type      = buffer[0x18 + r_vstate];
 817        comp->children  = ldm_get_vnum (buffer + 0x1D + r_vstate);
 818        comp->parent_id = ldm_get_vnum (buffer + 0x2D + r_child);
 819        comp->chunksize = r_stripe ? ldm_get_vnum (buffer+r_parent+0x2E) : 0;
 820
 821        return true;
 822}
 823
 824/**
 825 * ldm_parse_dgr3 - Read a raw VBLK Disk Group object into a vblk structure
 826 * @buffer:  Block of data being worked on
 827 * @buflen:  Size of the block of data
 828 * @vb:      In-memory vblk in which to return information
 829 *
 830 * Read a raw VBLK Disk Group object (version 3) into a vblk structure.
 831 *
 832 * Return:  'true'   @vb contains a Disk Group VBLK
 833 *          'false'  @vb contents are not defined
 834 */
 835static int ldm_parse_dgr3 (const u8 *buffer, int buflen, struct vblk *vb)
 836{
 837        int r_objid, r_name, r_diskid, r_id1, r_id2, len;
 838        struct vblk_dgrp *dgrp;
 839
 840        BUG_ON (!buffer || !vb);
 841
 842        r_objid  = ldm_relative (buffer, buflen, 0x18, 0);
 843        r_name   = ldm_relative (buffer, buflen, 0x18, r_objid);
 844        r_diskid = ldm_relative (buffer, buflen, 0x18, r_name);
 845
 846        if (buffer[0x12] & VBLK_FLAG_DGR3_IDS) {
 847                r_id1 = ldm_relative (buffer, buflen, 0x24, r_diskid);
 848                r_id2 = ldm_relative (buffer, buflen, 0x24, r_id1);
 849                len = r_id2;
 850        } else {
 851                r_id1 = 0;
 852                r_id2 = 0;
 853                len = r_diskid;
 854        }
 855        if (len < 0)
 856                return false;
 857
 858        len += VBLK_SIZE_DGR3;
 859        if (len != get_unaligned_be32(buffer + 0x14))
 860                return false;
 861
 862        dgrp = &vb->vblk.dgrp;
 863        ldm_get_vstr (buffer + 0x18 + r_name, dgrp->disk_id,
 864                sizeof (dgrp->disk_id));
 865        return true;
 866}
 867
 868/**
 869 * ldm_parse_dgr4 - Read a raw VBLK Disk Group object into a vblk structure
 870 * @buffer:  Block of data being worked on
 871 * @buflen:  Size of the block of data
 872 * @vb:      In-memory vblk in which to return information
 873 *
 874 * Read a raw VBLK Disk Group object (version 4) into a vblk structure.
 875 *
 876 * Return:  'true'   @vb contains a Disk Group VBLK
 877 *          'false'  @vb contents are not defined
 878 */
 879static bool ldm_parse_dgr4 (const u8 *buffer, int buflen, struct vblk *vb)
 880{
 881        char buf[64];
 882        int r_objid, r_name, r_id1, r_id2, len;
 883        struct vblk_dgrp *dgrp;
 884
 885        BUG_ON (!buffer || !vb);
 886
 887        r_objid  = ldm_relative (buffer, buflen, 0x18, 0);
 888        r_name   = ldm_relative (buffer, buflen, 0x18, r_objid);
 889
 890        if (buffer[0x12] & VBLK_FLAG_DGR4_IDS) {
 891                r_id1 = ldm_relative (buffer, buflen, 0x44, r_name);
 892                r_id2 = ldm_relative (buffer, buflen, 0x44, r_id1);
 893                len = r_id2;
 894        } else {
 895                r_id1 = 0;
 896                r_id2 = 0;
 897                len = r_name;
 898        }
 899        if (len < 0)
 900                return false;
 901
 902        len += VBLK_SIZE_DGR4;
 903        if (len != get_unaligned_be32(buffer + 0x14))
 904                return false;
 905
 906        dgrp = &vb->vblk.dgrp;
 907
 908        ldm_get_vstr (buffer + 0x18 + r_objid, buf, sizeof (buf));
 909        return true;
 910}
 911
 912/**
 913 * ldm_parse_dsk3 - Read a raw VBLK Disk object into a vblk structure
 914 * @buffer:  Block of data being worked on
 915 * @buflen:  Size of the block of data
 916 * @vb:      In-memory vblk in which to return information
 917 *
 918 * Read a raw VBLK Disk object (version 3) into a vblk structure.
 919 *
 920 * Return:  'true'   @vb contains a Disk VBLK
 921 *          'false'  @vb contents are not defined
 922 */
 923static bool ldm_parse_dsk3 (const u8 *buffer, int buflen, struct vblk *vb)
 924{
 925        int r_objid, r_name, r_diskid, r_altname, len;
 926        struct vblk_disk *disk;
 927
 928        BUG_ON (!buffer || !vb);
 929
 930        r_objid   = ldm_relative (buffer, buflen, 0x18, 0);
 931        r_name    = ldm_relative (buffer, buflen, 0x18, r_objid);
 932        r_diskid  = ldm_relative (buffer, buflen, 0x18, r_name);
 933        r_altname = ldm_relative (buffer, buflen, 0x18, r_diskid);
 934        len = r_altname;
 935        if (len < 0)
 936                return false;
 937
 938        len += VBLK_SIZE_DSK3;
 939        if (len != get_unaligned_be32(buffer + 0x14))
 940                return false;
 941
 942        disk = &vb->vblk.disk;
 943        ldm_get_vstr (buffer + 0x18 + r_diskid, disk->alt_name,
 944                sizeof (disk->alt_name));
 945        if (!ldm_parse_guid (buffer + 0x19 + r_name, disk->disk_id))
 946                return false;
 947
 948        return true;
 949}
 950
 951/**
 952 * ldm_parse_dsk4 - Read a raw VBLK Disk object into a vblk structure
 953 * @buffer:  Block of data being worked on
 954 * @buflen:  Size of the block of data
 955 * @vb:      In-memory vblk in which to return information
 956 *
 957 * Read a raw VBLK Disk object (version 4) into a vblk structure.
 958 *
 959 * Return:  'true'   @vb contains a Disk VBLK
 960 *          'false'  @vb contents are not defined
 961 */
 962static bool ldm_parse_dsk4 (const u8 *buffer, int buflen, struct vblk *vb)
 963{
 964        int r_objid, r_name, len;
 965        struct vblk_disk *disk;
 966
 967        BUG_ON (!buffer || !vb);
 968
 969        r_objid = ldm_relative (buffer, buflen, 0x18, 0);
 970        r_name  = ldm_relative (buffer, buflen, 0x18, r_objid);
 971        len     = r_name;
 972        if (len < 0)
 973                return false;
 974
 975        len += VBLK_SIZE_DSK4;
 976        if (len != get_unaligned_be32(buffer + 0x14))
 977                return false;
 978
 979        disk = &vb->vblk.disk;
 980        memcpy (disk->disk_id, buffer + 0x18 + r_name, GUID_SIZE);
 981        return true;
 982}
 983
 984/**
 985 * ldm_parse_prt3 - Read a raw VBLK Partition object into a vblk structure
 986 * @buffer:  Block of data being worked on
 987 * @buflen:  Size of the block of data
 988 * @vb:      In-memory vblk in which to return information
 989 *
 990 * Read a raw VBLK Partition object (version 3) into a vblk structure.
 991 *
 992 * Return:  'true'   @vb contains a Partition VBLK
 993 *          'false'  @vb contents are not defined
 994 */
 995static bool ldm_parse_prt3(const u8 *buffer, int buflen, struct vblk *vb)
 996{
 997        int r_objid, r_name, r_size, r_parent, r_diskid, r_index, len;
 998        struct vblk_part *part;
 999
1000        BUG_ON(!buffer || !vb);
1001        r_objid = ldm_relative(buffer, buflen, 0x18, 0);
1002        if (r_objid < 0) {
1003                ldm_error("r_objid %d < 0", r_objid);
1004                return false;
1005        }
1006        r_name = ldm_relative(buffer, buflen, 0x18, r_objid);
1007        if (r_name < 0) {
1008                ldm_error("r_name %d < 0", r_name);
1009                return false;
1010        }
1011        r_size = ldm_relative(buffer, buflen, 0x34, r_name);
1012        if (r_size < 0) {
1013                ldm_error("r_size %d < 0", r_size);
1014                return false;
1015        }
1016        r_parent = ldm_relative(buffer, buflen, 0x34, r_size);
1017        if (r_parent < 0) {
1018                ldm_error("r_parent %d < 0", r_parent);
1019                return false;
1020        }
1021        r_diskid = ldm_relative(buffer, buflen, 0x34, r_parent);
1022        if (r_diskid < 0) {
1023                ldm_error("r_diskid %d < 0", r_diskid);
1024                return false;
1025        }
1026        if (buffer[0x12] & VBLK_FLAG_PART_INDEX) {
1027                r_index = ldm_relative(buffer, buflen, 0x34, r_diskid);
1028                if (r_index < 0) {
1029                        ldm_error("r_index %d < 0", r_index);
1030                        return false;
1031                }
1032                len = r_index;
1033        } else {
1034                r_index = 0;
1035                len = r_diskid;
1036        }
1037        if (len < 0) {
1038                ldm_error("len %d < 0", len);
1039                return false;
1040        }
1041        len += VBLK_SIZE_PRT3;
1042        if (len > get_unaligned_be32(buffer + 0x14)) {
1043                ldm_error("len %d > BE32(buffer + 0x14) %d", len,
1044                                get_unaligned_be32(buffer + 0x14));
1045                return false;
1046        }
1047        part = &vb->vblk.part;
1048        part->start = get_unaligned_be64(buffer + 0x24 + r_name);
1049        part->volume_offset = get_unaligned_be64(buffer + 0x2C + r_name);
1050        part->size = ldm_get_vnum(buffer + 0x34 + r_name);
1051        part->parent_id = ldm_get_vnum(buffer + 0x34 + r_size);
1052        part->disk_id = ldm_get_vnum(buffer + 0x34 + r_parent);
1053        if (vb->flags & VBLK_FLAG_PART_INDEX)
1054                part->partnum = buffer[0x35 + r_diskid];
1055        else
1056                part->partnum = 0;
1057        return true;
1058}
1059
1060/**
1061 * ldm_parse_vol5 - Read a raw VBLK Volume object into a vblk structure
1062 * @buffer:  Block of data being worked on
1063 * @buflen:  Size of the block of data
1064 * @vb:      In-memory vblk in which to return information
1065 *
1066 * Read a raw VBLK Volume object (version 5) into a vblk structure.
1067 *
1068 * Return:  'true'   @vb contains a Volume VBLK
1069 *          'false'  @vb contents are not defined
1070 */
1071static bool ldm_parse_vol5(const u8 *buffer, int buflen, struct vblk *vb)
1072{
1073        int r_objid, r_name, r_vtype, r_disable_drive_letter, r_child, r_size;
1074        int r_id1, r_id2, r_size2, r_drive, len;
1075        struct vblk_volu *volu;
1076
1077        BUG_ON(!buffer || !vb);
1078        r_objid = ldm_relative(buffer, buflen, 0x18, 0);
1079        if (r_objid < 0) {
1080                ldm_error("r_objid %d < 0", r_objid);
1081                return false;
1082        }
1083        r_name = ldm_relative(buffer, buflen, 0x18, r_objid);
1084        if (r_name < 0) {
1085                ldm_error("r_name %d < 0", r_name);
1086                return false;
1087        }
1088        r_vtype = ldm_relative(buffer, buflen, 0x18, r_name);
1089        if (r_vtype < 0) {
1090                ldm_error("r_vtype %d < 0", r_vtype);
1091                return false;
1092        }
1093        r_disable_drive_letter = ldm_relative(buffer, buflen, 0x18, r_vtype);
1094        if (r_disable_drive_letter < 0) {
1095                ldm_error("r_disable_drive_letter %d < 0",
1096                                r_disable_drive_letter);
1097                return false;
1098        }
1099        r_child = ldm_relative(buffer, buflen, 0x2D, r_disable_drive_letter);
1100        if (r_child < 0) {
1101                ldm_error("r_child %d < 0", r_child);
1102                return false;
1103        }
1104        r_size = ldm_relative(buffer, buflen, 0x3D, r_child);
1105        if (r_size < 0) {
1106                ldm_error("r_size %d < 0", r_size);
1107                return false;
1108        }
1109        if (buffer[0x12] & VBLK_FLAG_VOLU_ID1) {
1110                r_id1 = ldm_relative(buffer, buflen, 0x52, r_size);
1111                if (r_id1 < 0) {
1112                        ldm_error("r_id1 %d < 0", r_id1);
1113                        return false;
1114                }
1115        } else
1116                r_id1 = r_size;
1117        if (buffer[0x12] & VBLK_FLAG_VOLU_ID2) {
1118                r_id2 = ldm_relative(buffer, buflen, 0x52, r_id1);
1119                if (r_id2 < 0) {
1120                        ldm_error("r_id2 %d < 0", r_id2);
1121                        return false;
1122                }
1123        } else
1124                r_id2 = r_id1;
1125        if (buffer[0x12] & VBLK_FLAG_VOLU_SIZE) {
1126                r_size2 = ldm_relative(buffer, buflen, 0x52, r_id2);
1127                if (r_size2 < 0) {
1128                        ldm_error("r_size2 %d < 0", r_size2);
1129                        return false;
1130                }
1131        } else
1132                r_size2 = r_id2;
1133        if (buffer[0x12] & VBLK_FLAG_VOLU_DRIVE) {
1134                r_drive = ldm_relative(buffer, buflen, 0x52, r_size2);
1135                if (r_drive < 0) {
1136                        ldm_error("r_drive %d < 0", r_drive);
1137                        return false;
1138                }
1139        } else
1140                r_drive = r_size2;
1141        len = r_drive;
1142        if (len < 0) {
1143                ldm_error("len %d < 0", len);
1144                return false;
1145        }
1146        len += VBLK_SIZE_VOL5;
1147        if (len > get_unaligned_be32(buffer + 0x14)) {
1148                ldm_error("len %d > BE32(buffer + 0x14) %d", len,
1149                                get_unaligned_be32(buffer + 0x14));
1150                return false;
1151        }
1152        volu = &vb->vblk.volu;
1153        ldm_get_vstr(buffer + 0x18 + r_name, volu->volume_type,
1154                        sizeof(volu->volume_type));
1155        memcpy(volu->volume_state, buffer + 0x18 + r_disable_drive_letter,
1156                        sizeof(volu->volume_state));
1157        volu->size = ldm_get_vnum(buffer + 0x3D + r_child);
1158        volu->partition_type = buffer[0x41 + r_size];
1159        memcpy(volu->guid, buffer + 0x42 + r_size, sizeof(volu->guid));
1160        if (buffer[0x12] & VBLK_FLAG_VOLU_DRIVE) {
1161                ldm_get_vstr(buffer + 0x52 + r_size, volu->drive_hint,
1162                                sizeof(volu->drive_hint));
1163        }
1164        return true;
1165}
1166
1167/**
1168 * ldm_parse_vblk - Read a raw VBLK object into a vblk structure
1169 * @buf:  Block of data being worked on
1170 * @len:  Size of the block of data
1171 * @vb:   In-memory vblk in which to return information
1172 *
1173 * Read a raw VBLK object into a vblk structure.  This function just reads the
1174 * information common to all VBLK types, then delegates the rest of the work to
1175 * helper functions: ldm_parse_*.
1176 *
1177 * Return:  'true'   @vb contains a VBLK
1178 *          'false'  @vb contents are not defined
1179 */
1180static bool ldm_parse_vblk (const u8 *buf, int len, struct vblk *vb)
1181{
1182        bool result = false;
1183        int r_objid;
1184
1185        BUG_ON (!buf || !vb);
1186
1187        r_objid = ldm_relative (buf, len, 0x18, 0);
1188        if (r_objid < 0) {
1189                ldm_error ("VBLK header is corrupt.");
1190                return false;
1191        }
1192
1193        vb->flags  = buf[0x12];
1194        vb->type   = buf[0x13];
1195        vb->obj_id = ldm_get_vnum (buf + 0x18);
1196        ldm_get_vstr (buf+0x18+r_objid, vb->name, sizeof (vb->name));
1197
1198        switch (vb->type) {
1199                case VBLK_CMP3:  result = ldm_parse_cmp3 (buf, len, vb); break;
1200                case VBLK_DSK3:  result = ldm_parse_dsk3 (buf, len, vb); break;
1201                case VBLK_DSK4:  result = ldm_parse_dsk4 (buf, len, vb); break;
1202                case VBLK_DGR3:  result = ldm_parse_dgr3 (buf, len, vb); break;
1203                case VBLK_DGR4:  result = ldm_parse_dgr4 (buf, len, vb); break;
1204                case VBLK_PRT3:  result = ldm_parse_prt3 (buf, len, vb); break;
1205                case VBLK_VOL5:  result = ldm_parse_vol5 (buf, len, vb); break;
1206        }
1207
1208        if (result)
1209                ldm_debug ("Parsed VBLK 0x%llx (type: 0x%02x) ok.",
1210                         (unsigned long long) vb->obj_id, vb->type);
1211        else
1212                ldm_error ("Failed to parse VBLK 0x%llx (type: 0x%02x).",
1213                        (unsigned long long) vb->obj_id, vb->type);
1214
1215        return result;
1216}
1217
1218
1219/**
1220 * ldm_ldmdb_add - Adds a raw VBLK entry to the ldmdb database
1221 * @data:  Raw VBLK to add to the database
1222 * @len:   Size of the raw VBLK
1223 * @ldb:   Cache of the database structures
1224 *
1225 * The VBLKs are sorted into categories.  Partitions are also sorted by offset.
1226 *
1227 * N.B.  This function does not check the validity of the VBLKs.
1228 *
1229 * Return:  'true'   The VBLK was added
1230 *          'false'  An error occurred
1231 */
1232static bool ldm_ldmdb_add (u8 *data, int len, struct ldmdb *ldb)
1233{
1234        struct vblk *vb;
1235        struct list_head *item;
1236
1237        BUG_ON (!data || !ldb);
1238
1239        vb = kmalloc (sizeof (*vb), GFP_KERNEL);
1240        if (!vb) {
1241                ldm_crit ("Out of memory.");
1242                return false;
1243        }
1244
1245        if (!ldm_parse_vblk (data, len, vb)) {
1246                kfree(vb);
1247                return false;                   /* Already logged */
1248        }
1249
1250        /* Put vblk into the correct list. */
1251        switch (vb->type) {
1252        case VBLK_DGR3:
1253        case VBLK_DGR4:
1254                list_add (&vb->list, &ldb->v_dgrp);
1255                break;
1256        case VBLK_DSK3:
1257        case VBLK_DSK4:
1258                list_add (&vb->list, &ldb->v_disk);
1259                break;
1260        case VBLK_VOL5:
1261                list_add (&vb->list, &ldb->v_volu);
1262                break;
1263        case VBLK_CMP3:
1264                list_add (&vb->list, &ldb->v_comp);
1265                break;
1266        case VBLK_PRT3:
1267                /* Sort by the partition's start sector. */
1268                list_for_each (item, &ldb->v_part) {
1269                        struct vblk *v = list_entry (item, struct vblk, list);
1270                        if ((v->vblk.part.disk_id == vb->vblk.part.disk_id) &&
1271                            (v->vblk.part.start > vb->vblk.part.start)) {
1272                                list_add_tail (&vb->list, &v->list);
1273                                return true;
1274                        }
1275                }
1276                list_add_tail (&vb->list, &ldb->v_part);
1277                break;
1278        }
1279        return true;
1280}
1281
1282/**
1283 * ldm_frag_add - Add a VBLK fragment to a list
1284 * @data:   Raw fragment to be added to the list
1285 * @size:   Size of the raw fragment
1286 * @frags:  Linked list of VBLK fragments
1287 *
1288 * Fragmented VBLKs may not be consecutive in the database, so they are placed
1289 * in a list so they can be pieced together later.
1290 *
1291 * Return:  'true'   Success, the VBLK was added to the list
1292 *          'false'  Error, a problem occurred
1293 */
1294static bool ldm_frag_add (const u8 *data, int size, struct list_head *frags)
1295{
1296        struct frag *f;
1297        struct list_head *item;
1298        int rec, num, group;
1299
1300        BUG_ON (!data || !frags);
1301
1302        group = get_unaligned_be32(data + 0x08);
1303        rec   = get_unaligned_be16(data + 0x0C);
1304        num   = get_unaligned_be16(data + 0x0E);
1305        if ((num < 1) || (num > 4)) {
1306                ldm_error ("A VBLK claims to have %d parts.", num);
1307                return false;
1308        }
1309
1310        list_for_each (item, frags) {
1311                f = list_entry (item, struct frag, list);
1312                if (f->group == group)
1313                        goto found;
1314        }
1315
1316        f = kmalloc (sizeof (*f) + size*num, GFP_KERNEL);
1317        if (!f) {
1318                ldm_crit ("Out of memory.");
1319                return false;
1320        }
1321
1322        f->group = group;
1323        f->num   = num;
1324        f->rec   = rec;
1325        f->map   = 0xFF << num;
1326
1327        list_add_tail (&f->list, frags);
1328found:
1329        if (f->map & (1 << rec)) {
1330                ldm_error ("Duplicate VBLK, part %d.", rec);
1331                f->map &= 0x7F;                 /* Mark the group as broken */
1332                return false;
1333        }
1334
1335        f->map |= (1 << rec);
1336
1337        if (num > 0) {
1338                data += VBLK_SIZE_HEAD;
1339                size -= VBLK_SIZE_HEAD;
1340        }
1341        memcpy (f->data+rec*(size-VBLK_SIZE_HEAD)+VBLK_SIZE_HEAD, data, size);
1342
1343        return true;
1344}
1345
1346/**
1347 * ldm_frag_free - Free a linked list of VBLK fragments
1348 * @list:  Linked list of fragments
1349 *
1350 * Free a linked list of VBLK fragments
1351 *
1352 * Return:  none
1353 */
1354static void ldm_frag_free (struct list_head *list)
1355{
1356        struct list_head *item, *tmp;
1357
1358        BUG_ON (!list);
1359
1360        list_for_each_safe (item, tmp, list)
1361                kfree (list_entry (item, struct frag, list));
1362}
1363
1364/**
1365 * ldm_frag_commit - Validate fragmented VBLKs and add them to the database
1366 * @frags:  Linked list of VBLK fragments
1367 * @ldb:    Cache of the database structures
1368 *
1369 * Now that all the fragmented VBLKs have been collected, they must be added to
1370 * the database for later use.
1371 *
1372 * Return:  'true'   All the fragments we added successfully
1373 *          'false'  One or more of the fragments we invalid
1374 */
1375static bool ldm_frag_commit (struct list_head *frags, struct ldmdb *ldb)
1376{
1377        struct frag *f;
1378        struct list_head *item;
1379
1380        BUG_ON (!frags || !ldb);
1381
1382        list_for_each (item, frags) {
1383                f = list_entry (item, struct frag, list);
1384
1385                if (f->map != 0xFF) {
1386                        ldm_error ("VBLK group %d is incomplete (0x%02x).",
1387                                f->group, f->map);
1388                        return false;
1389                }
1390
1391                if (!ldm_ldmdb_add (f->data, f->num*ldb->vm.vblk_size, ldb))
1392                        return false;           /* Already logged */
1393        }
1394        return true;
1395}
1396
1397/**
1398 * ldm_get_vblks - Read the on-disk database of VBLKs into memory
1399 * @state: Partition check state including device holding the LDM Database
1400 * @base:  Offset, into @state->bdev, of the database
1401 * @ldb:   Cache of the database structures
1402 *
1403 * To use the information from the VBLKs, they need to be read from the disk,
1404 * unpacked and validated.  We cache them in @ldb according to their type.
1405 *
1406 * Return:  'true'   All the VBLKs were read successfully
1407 *          'false'  An error occurred
1408 */
1409static bool ldm_get_vblks(struct parsed_partitions *state, unsigned long base,
1410                          struct ldmdb *ldb)
1411{
1412        int size, perbuf, skip, finish, s, v, recs;
1413        u8 *data = NULL;
1414        Sector sect;
1415        bool result = false;
1416        LIST_HEAD (frags);
1417
1418        BUG_ON(!state || !ldb);
1419
1420        size   = ldb->vm.vblk_size;
1421        perbuf = 512 / size;
1422        skip   = ldb->vm.vblk_offset >> 9;              /* Bytes to sectors */
1423        finish = (size * ldb->vm.last_vblk_seq) >> 9;
1424
1425        for (s = skip; s < finish; s++) {               /* For each sector */
1426                data = read_part_sector(state, base + OFF_VMDB + s, &sect);
1427                if (!data) {
1428                        ldm_crit ("Disk read failed.");
1429                        goto out;
1430                }
1431
1432                for (v = 0; v < perbuf; v++, data+=size) {  /* For each vblk */
1433                        if (MAGIC_VBLK != get_unaligned_be32(data)) {
1434                                ldm_error ("Expected to find a VBLK.");
1435                                goto out;
1436                        }
1437
1438                        recs = get_unaligned_be16(data + 0x0E); /* Number of records */
1439                        if (recs == 1) {
1440                                if (!ldm_ldmdb_add (data, size, ldb))
1441                                        goto out;       /* Already logged */
1442                        } else if (recs > 1) {
1443                                if (!ldm_frag_add (data, size, &frags))
1444                                        goto out;       /* Already logged */
1445                        }
1446                        /* else Record is not in use, ignore it. */
1447                }
1448                put_dev_sector (sect);
1449                data = NULL;
1450        }
1451
1452        result = ldm_frag_commit (&frags, ldb); /* Failures, already logged */
1453out:
1454        if (data)
1455                put_dev_sector (sect);
1456        ldm_frag_free (&frags);
1457
1458        return result;
1459}
1460
1461/**
1462 * ldm_free_vblks - Free a linked list of vblk's
1463 * @lh:  Head of a linked list of struct vblk
1464 *
1465 * Free a list of vblk's and free the memory used to maintain the list.
1466 *
1467 * Return:  none
1468 */
1469static void ldm_free_vblks (struct list_head *lh)
1470{
1471        struct list_head *item, *tmp;
1472
1473        BUG_ON (!lh);
1474
1475        list_for_each_safe (item, tmp, lh)
1476                kfree (list_entry (item, struct vblk, list));
1477}
1478
1479
1480/**
1481 * ldm_partition - Find out whether a device is a dynamic disk and handle it
1482 * @state: Partition check state including device holding the LDM Database
1483 *
1484 * This determines whether the device @bdev is a dynamic disk and if so creates
1485 * the partitions necessary in the gendisk structure pointed to by @hd.
1486 *
1487 * We create a dummy device 1, which contains the LDM database, and then create
1488 * each partition described by the LDM database in sequence as devices 2+. For
1489 * example, if the device is hda, we would have: hda1: LDM database, hda2, hda3,
1490 * and so on: the actual data containing partitions.
1491 *
1492 * Return:  1 Success, @state->bdev is a dynamic disk and we handled it
1493 *          0 Success, @state->bdev is not a dynamic disk
1494 *         -1 An error occurred before enough information had been read
1495 *            Or @state->bdev is a dynamic disk, but it may be corrupted
1496 */
1497int ldm_partition(struct parsed_partitions *state)
1498{
1499        struct ldmdb  *ldb;
1500        unsigned long base;
1501        int result = -1;
1502
1503        BUG_ON(!state);
1504
1505        /* Look for signs of a Dynamic Disk */
1506        if (!ldm_validate_partition_table(state))
1507                return 0;
1508
1509        ldb = kmalloc (sizeof (*ldb), GFP_KERNEL);
1510        if (!ldb) {
1511                ldm_crit ("Out of memory.");
1512                goto out;
1513        }
1514
1515        /* Parse and check privheads. */
1516        if (!ldm_validate_privheads(state, &ldb->ph))
1517                goto out;               /* Already logged */
1518
1519        /* All further references are relative to base (database start). */
1520        base = ldb->ph.config_start;
1521
1522        /* Parse and check tocs and vmdb. */
1523        if (!ldm_validate_tocblocks(state, base, ldb) ||
1524            !ldm_validate_vmdb(state, base, ldb))
1525                goto out;               /* Already logged */
1526
1527        /* Initialize vblk lists in ldmdb struct */
1528        INIT_LIST_HEAD (&ldb->v_dgrp);
1529        INIT_LIST_HEAD (&ldb->v_disk);
1530        INIT_LIST_HEAD (&ldb->v_volu);
1531        INIT_LIST_HEAD (&ldb->v_comp);
1532        INIT_LIST_HEAD (&ldb->v_part);
1533
1534        if (!ldm_get_vblks(state, base, ldb)) {
1535                ldm_crit ("Failed to read the VBLKs from the database.");
1536                goto cleanup;
1537        }
1538
1539        /* Finally, create the data partition devices. */
1540        if (ldm_create_data_partitions(state, ldb)) {
1541                ldm_debug ("Parsed LDM database successfully.");
1542                result = 1;
1543        }
1544        /* else Already logged */
1545
1546cleanup:
1547        ldm_free_vblks (&ldb->v_dgrp);
1548        ldm_free_vblks (&ldb->v_disk);
1549        ldm_free_vblks (&ldb->v_volu);
1550        ldm_free_vblks (&ldb->v_comp);
1551        ldm_free_vblks (&ldb->v_part);
1552out:
1553        kfree (ldb);
1554        return result;
1555}
1556