2 * ldm - Support for Windows Logical Disk Manager (Dynamic Disks)
5 * Copyright (c) 2001-2012 Anton Altaparmakov
8 * Documentation is available at http://www.linux-ntfs.org/doku.php?id=downloads
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
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
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
26 #include <linux/slab.h>
27 #include <linux/pagemap.h>
28 #include <linux/stringify.h>
29 #include <linux/kernel.h>
30 #include <linux/uuid.h>
37 * ldm_debug/info/error/crit - Output an error message
38 * @f: A printf format string containing the message
39 * @...: Variables to substitute into @f
41 * ldm_debug() writes a DEBUG level message to the syslog but only if the
42 * driver was compiled with debug enabled. Otherwise, the call turns into a NOP.
44 #ifndef CONFIG_LDM_DEBUG
45 #define ldm_debug(...) do {} while (0)
47 #define ldm_debug(f, a...) _ldm_printk (KERN_DEBUG, __func__, f, ##a)
50 #define ldm_crit(f, a...) _ldm_printk (KERN_CRIT, __func__, f, ##a)
51 #define ldm_error(f, a...) _ldm_printk (KERN_ERR, __func__, f, ##a)
52 #define ldm_info(f, a...) _ldm_printk (KERN_INFO, __func__, f, ##a)
55 void _ldm_printk(const char *level, const char *function, const char *fmt, ...)
65 printk("%s%s(): %pV\n", level, function, &vaf);
71 * ldm_parse_privhead - Read the LDM Database PRIVHEAD structure
72 * @data: Raw database PRIVHEAD structure loaded from the device
73 * @ph: In-memory privhead structure in which to return parsed information
75 * This parses the LDM database PRIVHEAD structure supplied in @data and
76 * sets up the in-memory privhead structure @ph with the obtained information.
78 * Return: 'true' @ph contains the PRIVHEAD data
79 * 'false' @ph contents are undefined
81 static bool ldm_parse_privhead(const u8 *data, struct privhead *ph)
83 bool is_vista = false;
86 if (MAGIC_PRIVHEAD != get_unaligned_be64(data)) {
87 ldm_error("Cannot find PRIVHEAD structure. LDM database is"
88 " corrupt. Aborting.");
91 ph->ver_major = get_unaligned_be16(data + 0x000C);
92 ph->ver_minor = get_unaligned_be16(data + 0x000E);
93 ph->logical_disk_start = get_unaligned_be64(data + 0x011B);
94 ph->logical_disk_size = get_unaligned_be64(data + 0x0123);
95 ph->config_start = get_unaligned_be64(data + 0x012B);
96 ph->config_size = get_unaligned_be64(data + 0x0133);
97 /* Version 2.11 is Win2k/XP and version 2.12 is Vista. */
98 if (ph->ver_major == 2 && ph->ver_minor == 12)
100 if (!is_vista && (ph->ver_major != 2 || ph->ver_minor != 11)) {
101 ldm_error("Expected PRIVHEAD version 2.11 or 2.12, got %d.%d."
102 " Aborting.", ph->ver_major, ph->ver_minor);
105 ldm_debug("PRIVHEAD version %d.%d (Windows %s).", ph->ver_major,
106 ph->ver_minor, is_vista ? "Vista" : "2000/XP");
107 if (ph->config_size != LDM_DB_SIZE) { /* 1 MiB in sectors. */
108 /* Warn the user and continue, carefully. */
109 ldm_info("Database is normally %u bytes, it claims to "
110 "be %llu bytes.", LDM_DB_SIZE,
111 (unsigned long long)ph->config_size);
113 if ((ph->logical_disk_size == 0) || (ph->logical_disk_start +
114 ph->logical_disk_size > ph->config_start)) {
115 ldm_error("PRIVHEAD disk size doesn't match real disk size");
118 if (uuid_parse(data + 0x0030, &ph->disk_id)) {
119 ldm_error("PRIVHEAD contains an invalid GUID.");
122 ldm_debug("Parsed PRIVHEAD successfully.");
127 * ldm_parse_tocblock - Read the LDM Database TOCBLOCK structure
128 * @data: Raw database TOCBLOCK structure loaded from the device
129 * @toc: In-memory toc structure in which to return parsed information
131 * This parses the LDM Database TOCBLOCK (table of contents) structure supplied
132 * in @data and sets up the in-memory tocblock structure @toc with the obtained
135 * N.B. The *_start and *_size values returned in @toc are not range-checked.
137 * Return: 'true' @toc contains the TOCBLOCK data
138 * 'false' @toc contents are undefined
140 static bool ldm_parse_tocblock (const u8 *data, struct tocblock *toc)
142 BUG_ON (!data || !toc);
144 if (MAGIC_TOCBLOCK != get_unaligned_be64(data)) {
145 ldm_crit ("Cannot find TOCBLOCK, database may be corrupt.");
148 strncpy (toc->bitmap1_name, data + 0x24, sizeof (toc->bitmap1_name));
149 toc->bitmap1_name[sizeof (toc->bitmap1_name) - 1] = 0;
150 toc->bitmap1_start = get_unaligned_be64(data + 0x2E);
151 toc->bitmap1_size = get_unaligned_be64(data + 0x36);
153 if (strncmp (toc->bitmap1_name, TOC_BITMAP1,
154 sizeof (toc->bitmap1_name)) != 0) {
155 ldm_crit ("TOCBLOCK's first bitmap is '%s', should be '%s'.",
156 TOC_BITMAP1, toc->bitmap1_name);
159 strncpy (toc->bitmap2_name, data + 0x46, sizeof (toc->bitmap2_name));
160 toc->bitmap2_name[sizeof (toc->bitmap2_name) - 1] = 0;
161 toc->bitmap2_start = get_unaligned_be64(data + 0x50);
162 toc->bitmap2_size = get_unaligned_be64(data + 0x58);
163 if (strncmp (toc->bitmap2_name, TOC_BITMAP2,
164 sizeof (toc->bitmap2_name)) != 0) {
165 ldm_crit ("TOCBLOCK's second bitmap is '%s', should be '%s'.",
166 TOC_BITMAP2, toc->bitmap2_name);
169 ldm_debug ("Parsed TOCBLOCK successfully.");
174 * ldm_parse_vmdb - Read the LDM Database VMDB structure
175 * @data: Raw database VMDB structure loaded from the device
176 * @vm: In-memory vmdb structure in which to return parsed information
178 * This parses the LDM Database VMDB structure supplied in @data and sets up
179 * the in-memory vmdb structure @vm with the obtained information.
181 * N.B. The *_start, *_size and *_seq values will be range-checked later.
183 * Return: 'true' @vm contains VMDB info
184 * 'false' @vm contents are undefined
186 static bool ldm_parse_vmdb (const u8 *data, struct vmdb *vm)
188 BUG_ON (!data || !vm);
190 if (MAGIC_VMDB != get_unaligned_be32(data)) {
191 ldm_crit ("Cannot find the VMDB, database may be corrupt.");
195 vm->ver_major = get_unaligned_be16(data + 0x12);
196 vm->ver_minor = get_unaligned_be16(data + 0x14);
197 if ((vm->ver_major != 4) || (vm->ver_minor != 10)) {
198 ldm_error ("Expected VMDB version %d.%d, got %d.%d. "
199 "Aborting.", 4, 10, vm->ver_major, vm->ver_minor);
203 vm->vblk_size = get_unaligned_be32(data + 0x08);
204 if (vm->vblk_size == 0) {
205 ldm_error ("Illegal VBLK size");
209 vm->vblk_offset = get_unaligned_be32(data + 0x0C);
210 vm->last_vblk_seq = get_unaligned_be32(data + 0x04);
212 ldm_debug ("Parsed VMDB successfully.");
217 * ldm_compare_privheads - Compare two privhead objects
218 * @ph1: First privhead
219 * @ph2: Second privhead
221 * This compares the two privhead structures @ph1 and @ph2.
223 * Return: 'true' Identical
226 static bool ldm_compare_privheads (const struct privhead *ph1,
227 const struct privhead *ph2)
229 BUG_ON (!ph1 || !ph2);
231 return ((ph1->ver_major == ph2->ver_major) &&
232 (ph1->ver_minor == ph2->ver_minor) &&
233 (ph1->logical_disk_start == ph2->logical_disk_start) &&
234 (ph1->logical_disk_size == ph2->logical_disk_size) &&
235 (ph1->config_start == ph2->config_start) &&
236 (ph1->config_size == ph2->config_size) &&
237 uuid_equal(&ph1->disk_id, &ph2->disk_id));
241 * ldm_compare_tocblocks - Compare two tocblock objects
245 * This compares the two tocblock structures @toc1 and @toc2.
247 * Return: 'true' Identical
250 static bool ldm_compare_tocblocks (const struct tocblock *toc1,
251 const struct tocblock *toc2)
253 BUG_ON (!toc1 || !toc2);
255 return ((toc1->bitmap1_start == toc2->bitmap1_start) &&
256 (toc1->bitmap1_size == toc2->bitmap1_size) &&
257 (toc1->bitmap2_start == toc2->bitmap2_start) &&
258 (toc1->bitmap2_size == toc2->bitmap2_size) &&
259 !strncmp (toc1->bitmap1_name, toc2->bitmap1_name,
260 sizeof (toc1->bitmap1_name)) &&
261 !strncmp (toc1->bitmap2_name, toc2->bitmap2_name,
262 sizeof (toc1->bitmap2_name)));
266 * ldm_validate_privheads - Compare the primary privhead with its backups
267 * @state: Partition check state including device holding the LDM Database
268 * @ph1: Memory struct to fill with ph contents
270 * Read and compare all three privheads from disk.
272 * The privheads on disk show the size and location of the main disk area and
273 * the configuration area (the database). The values are range-checked against
274 * @hd, which contains the real size of the disk.
276 * Return: 'true' Success
279 static bool ldm_validate_privheads(struct parsed_partitions *state,
280 struct privhead *ph1)
282 static const int off[3] = { OFF_PRIV1, OFF_PRIV2, OFF_PRIV3 };
283 struct privhead *ph[3] = { ph1 };
290 BUG_ON (!state || !ph1);
292 ph[1] = kmalloc (sizeof (*ph[1]), GFP_KERNEL);
293 ph[2] = kmalloc (sizeof (*ph[2]), GFP_KERNEL);
294 if (!ph[1] || !ph[2]) {
295 ldm_crit ("Out of memory.");
299 /* off[1 & 2] are relative to ph[0]->config_start */
300 ph[0]->config_start = 0;
302 /* Read and parse privheads */
303 for (i = 0; i < 3; i++) {
304 data = read_part_sector(state, ph[0]->config_start + off[i],
307 ldm_crit ("Disk read failed.");
310 result = ldm_parse_privhead (data, ph[i]);
311 put_dev_sector (sect);
313 ldm_error ("Cannot find PRIVHEAD %d.", i+1); /* Log again */
315 goto out; /* Already logged */
317 break; /* FIXME ignore for now, 3rd PH can fail on odd-sized disks */
321 num_sects = state->bdev->bd_inode->i_size >> 9;
323 if ((ph[0]->config_start > num_sects) ||
324 ((ph[0]->config_start + ph[0]->config_size) > num_sects)) {
325 ldm_crit ("Database extends beyond the end of the disk.");
329 if ((ph[0]->logical_disk_start > ph[0]->config_start) ||
330 ((ph[0]->logical_disk_start + ph[0]->logical_disk_size)
331 > ph[0]->config_start)) {
332 ldm_crit ("Disk and database overlap.");
336 if (!ldm_compare_privheads (ph[0], ph[1])) {
337 ldm_crit ("Primary and backup PRIVHEADs don't match.");
340 /* FIXME ignore this for now
341 if (!ldm_compare_privheads (ph[0], ph[2])) {
342 ldm_crit ("Primary and backup PRIVHEADs don't match.");
345 ldm_debug ("Validated PRIVHEADs successfully.");
354 * ldm_validate_tocblocks - Validate the table of contents and its backups
355 * @state: Partition check state including device holding the LDM Database
356 * @base: Offset, into @state->bdev, of the database
357 * @ldb: Cache of the database structures
359 * Find and compare the four tables of contents of the LDM Database stored on
360 * @state->bdev and return the parsed information into @toc1.
362 * The offsets and sizes of the configs are range-checked against a privhead.
364 * Return: 'true' @toc1 contains validated TOCBLOCK info
365 * 'false' @toc1 contents are undefined
367 static bool ldm_validate_tocblocks(struct parsed_partitions *state,
368 unsigned long base, struct ldmdb *ldb)
370 static const int off[4] = { OFF_TOCB1, OFF_TOCB2, OFF_TOCB3, OFF_TOCB4};
371 struct tocblock *tb[4];
378 BUG_ON(!state || !ldb);
381 tb[1] = kmalloc_array(3, sizeof(*tb[1]), GFP_KERNEL);
383 ldm_crit("Out of memory.");
386 tb[2] = (struct tocblock*)((u8*)tb[1] + sizeof(*tb[1]));
387 tb[3] = (struct tocblock*)((u8*)tb[2] + sizeof(*tb[2]));
389 * Try to read and parse all four TOCBLOCKs.
391 * Windows Vista LDM v2.12 does not always have all four TOCBLOCKs so
392 * skip any that fail as long as we get at least one valid TOCBLOCK.
394 for (nr_tbs = i = 0; i < 4; i++) {
395 data = read_part_sector(state, base + off[i], §);
397 ldm_error("Disk read failed for TOCBLOCK %d.", i);
400 if (ldm_parse_tocblock(data, tb[nr_tbs]))
402 put_dev_sector(sect);
405 ldm_crit("Failed to find a valid TOCBLOCK.");
408 /* Range check the TOCBLOCK against a privhead. */
409 if (((tb[0]->bitmap1_start + tb[0]->bitmap1_size) > ph->config_size) ||
410 ((tb[0]->bitmap2_start + tb[0]->bitmap2_size) >
412 ldm_crit("The bitmaps are out of range. Giving up.");
415 /* Compare all loaded TOCBLOCKs. */
416 for (i = 1; i < nr_tbs; i++) {
417 if (!ldm_compare_tocblocks(tb[0], tb[i])) {
418 ldm_crit("TOCBLOCKs 0 and %d do not match.", i);
422 ldm_debug("Validated %d TOCBLOCKs successfully.", nr_tbs);
430 * ldm_validate_vmdb - Read the VMDB and validate it
431 * @state: Partition check state including device holding the LDM Database
432 * @base: Offset, into @bdev, of the database
433 * @ldb: Cache of the database structures
435 * Find the vmdb of the LDM Database stored on @bdev and return the parsed
436 * information in @ldb.
438 * Return: 'true' @ldb contains validated VBDB info
439 * 'false' @ldb contents are undefined
441 static bool ldm_validate_vmdb(struct parsed_partitions *state,
442 unsigned long base, struct ldmdb *ldb)
448 struct tocblock *toc;
450 BUG_ON (!state || !ldb);
455 data = read_part_sector(state, base + OFF_VMDB, §);
457 ldm_crit ("Disk read failed.");
461 if (!ldm_parse_vmdb (data, vm))
462 goto out; /* Already logged */
464 /* Are there uncommitted transactions? */
465 if (get_unaligned_be16(data + 0x10) != 0x01) {
466 ldm_crit ("Database is not in a consistent state. Aborting.");
470 if (vm->vblk_offset != 512)
471 ldm_info ("VBLKs start at offset 0x%04x.", vm->vblk_offset);
474 * The last_vblkd_seq can be before the end of the vmdb, just make sure
475 * it is not out of bounds.
477 if ((vm->vblk_size * vm->last_vblk_seq) > (toc->bitmap1_size << 9)) {
478 ldm_crit ("VMDB exceeds allowed size specified by TOCBLOCK. "
479 "Database is corrupt. Aborting.");
485 put_dev_sector (sect);
491 * ldm_validate_partition_table - Determine whether bdev might be a dynamic disk
492 * @state: Partition check state including device holding the LDM Database
494 * This function provides a weak test to decide whether the device is a dynamic
495 * disk or not. It looks for an MS-DOS-style partition table containing at
496 * least one partition of type 0x42 (formerly SFS, now used by Windows for
499 * N.B. The only possible error can come from the read_part_sector and that is
500 * only likely to happen if the underlying device is strange. If that IS
501 * the case we should return zero to let someone else try.
503 * Return: 'true' @state->bdev is a dynamic disk
504 * 'false' @state->bdev is not a dynamic disk, or an error occurred
506 static bool ldm_validate_partition_table(struct parsed_partitions *state)
516 data = read_part_sector(state, 0, §);
518 ldm_info ("Disk read failed.");
522 if (*(__le16*) (data + 0x01FE) != cpu_to_le16 (MSDOS_LABEL_MAGIC))
525 p = (struct partition*)(data + 0x01BE);
526 for (i = 0; i < 4; i++, p++)
527 if (SYS_IND (p) == LDM_PARTITION) {
533 ldm_debug ("Found W2K dynamic disk partition type.");
536 put_dev_sector (sect);
541 * ldm_get_disk_objid - Search a linked list of vblk's for a given Disk Id
542 * @ldb: Cache of the database structures
544 * The LDM Database contains a list of all partitions on all dynamic disks.
545 * The primary PRIVHEAD, at the beginning of the physical disk, tells us
546 * the GUID of this disk. This function searches for the GUID in a linked
549 * Return: Pointer, A matching vblk was found
550 * NULL, No match, or an error
552 static struct vblk * ldm_get_disk_objid (const struct ldmdb *ldb)
554 struct list_head *item;
558 list_for_each (item, &ldb->v_disk) {
559 struct vblk *v = list_entry (item, struct vblk, list);
560 if (uuid_equal(&v->vblk.disk.disk_id, &ldb->ph.disk_id))
568 * ldm_create_data_partitions - Create data partitions for this device
569 * @pp: List of the partitions parsed so far
570 * @ldb: Cache of the database structures
572 * The database contains ALL the partitions for ALL disk groups, so we need to
573 * filter out this specific disk. Using the disk's object id, we can find all
574 * the partitions in the database that belong to this disk.
576 * Add each partition in our database, to the parsed_partitions structure.
578 * N.B. This function creates the partitions in the order it finds partition
579 * objects in the linked list.
581 * Return: 'true' Partition created
582 * 'false' Error, probably a range checking problem
584 static bool ldm_create_data_partitions (struct parsed_partitions *pp,
585 const struct ldmdb *ldb)
587 struct list_head *item;
590 struct vblk_part *part;
593 BUG_ON (!pp || !ldb);
595 disk = ldm_get_disk_objid (ldb);
597 ldm_crit ("Can't find the ID of this disk in the database.");
601 strlcat(pp->pp_buf, " [LDM]", PAGE_SIZE);
603 /* Create the data partitions */
604 list_for_each (item, &ldb->v_part) {
605 vb = list_entry (item, struct vblk, list);
606 part = &vb->vblk.part;
608 if (part->disk_id != disk->obj_id)
611 put_partition (pp, part_num, ldb->ph.logical_disk_start +
612 part->start, part->size);
616 strlcat(pp->pp_buf, "\n", PAGE_SIZE);
622 * ldm_relative - Calculate the next relative offset
623 * @buffer: Block of data being worked on
624 * @buflen: Size of the block of data
625 * @base: Size of the previous fixed width fields
626 * @offset: Cumulative size of the previous variable-width fields
628 * Because many of the VBLK fields are variable-width, it's necessary
629 * to calculate each offset based on the previous one and the length
630 * of the field it pointed to.
632 * Return: -1 Error, the calculated offset exceeded the size of the buffer
633 * n OK, a range-checked offset into buffer
635 static int ldm_relative(const u8 *buffer, int buflen, int base, int offset)
639 if (!buffer || offset < 0 || base > buflen) {
641 ldm_error("!buffer");
643 ldm_error("offset (%d) < 0", offset);
645 ldm_error("base (%d) > buflen (%d)", base, buflen);
648 if (base + buffer[base] >= buflen) {
649 ldm_error("base (%d) + buffer[base] (%d) >= buflen (%d)", base,
650 buffer[base], buflen);
653 return buffer[base] + offset + 1;
657 * ldm_get_vnum - Convert a variable-width, big endian number, into cpu order
658 * @block: Pointer to the variable-width number to convert
660 * Large numbers in the LDM Database are often stored in a packed format. Each
661 * number is prefixed by a one byte width marker. All numbers in the database
662 * are stored in big-endian byte order. This function reads one of these
663 * numbers and returns the result
665 * N.B. This function DOES NOT perform any range checking, though the most
666 * it will read is eight bytes.
669 * 0 Zero, or an error occurred
671 static u64 ldm_get_vnum (const u8 *block)
680 if (length && length <= 8)
682 tmp = (tmp << 8) | *block++;
684 ldm_error ("Illegal length %d.", length);
690 * ldm_get_vstr - Read a length-prefixed string into a buffer
691 * @block: Pointer to the length marker
692 * @buffer: Location to copy string to
693 * @buflen: Size of the output buffer
695 * Many of the strings in the LDM Database are not NULL terminated. Instead
696 * they are prefixed by a one byte length marker. This function copies one of
697 * these strings into a buffer.
699 * N.B. This function DOES NOT perform any range checking on the input.
700 * If the buffer is too small, the output will be truncated.
702 * Return: 0, Error and @buffer contents are undefined
703 * n, String length in characters (excluding NULL)
704 * buflen-1, String was truncated.
706 static int ldm_get_vstr (const u8 *block, u8 *buffer, int buflen)
710 BUG_ON (!block || !buffer);
713 if (length >= buflen) {
714 ldm_error ("Truncating string %d -> %d.", length, buflen);
717 memcpy (buffer, block + 1, length);
724 * ldm_parse_cmp3 - Read a raw VBLK Component object into a vblk structure
725 * @buffer: Block of data being worked on
726 * @buflen: Size of the block of data
727 * @vb: In-memory vblk in which to return information
729 * Read a raw VBLK Component object (version 3) into a vblk structure.
731 * Return: 'true' @vb contains a Component VBLK
732 * 'false' @vb contents are not defined
734 static bool ldm_parse_cmp3 (const u8 *buffer, int buflen, struct vblk *vb)
736 int r_objid, r_name, r_vstate, r_child, r_parent, r_stripe, r_cols, len;
737 struct vblk_comp *comp;
739 BUG_ON (!buffer || !vb);
741 r_objid = ldm_relative (buffer, buflen, 0x18, 0);
742 r_name = ldm_relative (buffer, buflen, 0x18, r_objid);
743 r_vstate = ldm_relative (buffer, buflen, 0x18, r_name);
744 r_child = ldm_relative (buffer, buflen, 0x1D, r_vstate);
745 r_parent = ldm_relative (buffer, buflen, 0x2D, r_child);
747 if (buffer[0x12] & VBLK_FLAG_COMP_STRIPE) {
748 r_stripe = ldm_relative (buffer, buflen, 0x2E, r_parent);
749 r_cols = ldm_relative (buffer, buflen, 0x2E, r_stripe);
759 len += VBLK_SIZE_CMP3;
760 if (len != get_unaligned_be32(buffer + 0x14))
763 comp = &vb->vblk.comp;
764 ldm_get_vstr (buffer + 0x18 + r_name, comp->state,
765 sizeof (comp->state));
766 comp->type = buffer[0x18 + r_vstate];
767 comp->children = ldm_get_vnum (buffer + 0x1D + r_vstate);
768 comp->parent_id = ldm_get_vnum (buffer + 0x2D + r_child);
769 comp->chunksize = r_stripe ? ldm_get_vnum (buffer+r_parent+0x2E) : 0;
775 * ldm_parse_dgr3 - Read a raw VBLK Disk Group object into a vblk structure
776 * @buffer: Block of data being worked on
777 * @buflen: Size of the block of data
778 * @vb: In-memory vblk in which to return information
780 * Read a raw VBLK Disk Group object (version 3) into a vblk structure.
782 * Return: 'true' @vb contains a Disk Group VBLK
783 * 'false' @vb contents are not defined
785 static int ldm_parse_dgr3 (const u8 *buffer, int buflen, struct vblk *vb)
787 int r_objid, r_name, r_diskid, r_id1, r_id2, len;
788 struct vblk_dgrp *dgrp;
790 BUG_ON (!buffer || !vb);
792 r_objid = ldm_relative (buffer, buflen, 0x18, 0);
793 r_name = ldm_relative (buffer, buflen, 0x18, r_objid);
794 r_diskid = ldm_relative (buffer, buflen, 0x18, r_name);
796 if (buffer[0x12] & VBLK_FLAG_DGR3_IDS) {
797 r_id1 = ldm_relative (buffer, buflen, 0x24, r_diskid);
798 r_id2 = ldm_relative (buffer, buflen, 0x24, r_id1);
808 len += VBLK_SIZE_DGR3;
809 if (len != get_unaligned_be32(buffer + 0x14))
812 dgrp = &vb->vblk.dgrp;
813 ldm_get_vstr (buffer + 0x18 + r_name, dgrp->disk_id,
814 sizeof (dgrp->disk_id));
819 * ldm_parse_dgr4 - Read a raw VBLK Disk Group object into a vblk structure
820 * @buffer: Block of data being worked on
821 * @buflen: Size of the block of data
822 * @vb: In-memory vblk in which to return information
824 * Read a raw VBLK Disk Group object (version 4) into a vblk structure.
826 * Return: 'true' @vb contains a Disk Group VBLK
827 * 'false' @vb contents are not defined
829 static bool ldm_parse_dgr4 (const u8 *buffer, int buflen, struct vblk *vb)
832 int r_objid, r_name, r_id1, r_id2, len;
834 BUG_ON (!buffer || !vb);
836 r_objid = ldm_relative (buffer, buflen, 0x18, 0);
837 r_name = ldm_relative (buffer, buflen, 0x18, r_objid);
839 if (buffer[0x12] & VBLK_FLAG_DGR4_IDS) {
840 r_id1 = ldm_relative (buffer, buflen, 0x44, r_name);
841 r_id2 = ldm_relative (buffer, buflen, 0x44, r_id1);
851 len += VBLK_SIZE_DGR4;
852 if (len != get_unaligned_be32(buffer + 0x14))
855 ldm_get_vstr (buffer + 0x18 + r_objid, buf, sizeof (buf));
860 * ldm_parse_dsk3 - Read a raw VBLK Disk object into a vblk structure
861 * @buffer: Block of data being worked on
862 * @buflen: Size of the block of data
863 * @vb: In-memory vblk in which to return information
865 * Read a raw VBLK Disk object (version 3) into a vblk structure.
867 * Return: 'true' @vb contains a Disk VBLK
868 * 'false' @vb contents are not defined
870 static bool ldm_parse_dsk3 (const u8 *buffer, int buflen, struct vblk *vb)
872 int r_objid, r_name, r_diskid, r_altname, len;
873 struct vblk_disk *disk;
875 BUG_ON (!buffer || !vb);
877 r_objid = ldm_relative (buffer, buflen, 0x18, 0);
878 r_name = ldm_relative (buffer, buflen, 0x18, r_objid);
879 r_diskid = ldm_relative (buffer, buflen, 0x18, r_name);
880 r_altname = ldm_relative (buffer, buflen, 0x18, r_diskid);
885 len += VBLK_SIZE_DSK3;
886 if (len != get_unaligned_be32(buffer + 0x14))
889 disk = &vb->vblk.disk;
890 ldm_get_vstr (buffer + 0x18 + r_diskid, disk->alt_name,
891 sizeof (disk->alt_name));
892 if (uuid_parse(buffer + 0x19 + r_name, &disk->disk_id))
899 * ldm_parse_dsk4 - Read a raw VBLK Disk object into a vblk structure
900 * @buffer: Block of data being worked on
901 * @buflen: Size of the block of data
902 * @vb: In-memory vblk in which to return information
904 * Read a raw VBLK Disk object (version 4) into a vblk structure.
906 * Return: 'true' @vb contains a Disk VBLK
907 * 'false' @vb contents are not defined
909 static bool ldm_parse_dsk4 (const u8 *buffer, int buflen, struct vblk *vb)
911 int r_objid, r_name, len;
912 struct vblk_disk *disk;
914 BUG_ON (!buffer || !vb);
916 r_objid = ldm_relative (buffer, buflen, 0x18, 0);
917 r_name = ldm_relative (buffer, buflen, 0x18, r_objid);
922 len += VBLK_SIZE_DSK4;
923 if (len != get_unaligned_be32(buffer + 0x14))
926 disk = &vb->vblk.disk;
927 uuid_copy(&disk->disk_id, (uuid_t *)(buffer + 0x18 + r_name));
932 * ldm_parse_prt3 - Read a raw VBLK Partition object into a vblk structure
933 * @buffer: Block of data being worked on
934 * @buflen: Size of the block of data
935 * @vb: In-memory vblk in which to return information
937 * Read a raw VBLK Partition object (version 3) into a vblk structure.
939 * Return: 'true' @vb contains a Partition VBLK
940 * 'false' @vb contents are not defined
942 static bool ldm_parse_prt3(const u8 *buffer, int buflen, struct vblk *vb)
944 int r_objid, r_name, r_size, r_parent, r_diskid, r_index, len;
945 struct vblk_part *part;
947 BUG_ON(!buffer || !vb);
948 r_objid = ldm_relative(buffer, buflen, 0x18, 0);
950 ldm_error("r_objid %d < 0", r_objid);
953 r_name = ldm_relative(buffer, buflen, 0x18, r_objid);
955 ldm_error("r_name %d < 0", r_name);
958 r_size = ldm_relative(buffer, buflen, 0x34, r_name);
960 ldm_error("r_size %d < 0", r_size);
963 r_parent = ldm_relative(buffer, buflen, 0x34, r_size);
965 ldm_error("r_parent %d < 0", r_parent);
968 r_diskid = ldm_relative(buffer, buflen, 0x34, r_parent);
970 ldm_error("r_diskid %d < 0", r_diskid);
973 if (buffer[0x12] & VBLK_FLAG_PART_INDEX) {
974 r_index = ldm_relative(buffer, buflen, 0x34, r_diskid);
976 ldm_error("r_index %d < 0", r_index);
985 ldm_error("len %d < 0", len);
988 len += VBLK_SIZE_PRT3;
989 if (len > get_unaligned_be32(buffer + 0x14)) {
990 ldm_error("len %d > BE32(buffer + 0x14) %d", len,
991 get_unaligned_be32(buffer + 0x14));
994 part = &vb->vblk.part;
995 part->start = get_unaligned_be64(buffer + 0x24 + r_name);
996 part->volume_offset = get_unaligned_be64(buffer + 0x2C + r_name);
997 part->size = ldm_get_vnum(buffer + 0x34 + r_name);
998 part->parent_id = ldm_get_vnum(buffer + 0x34 + r_size);
999 part->disk_id = ldm_get_vnum(buffer + 0x34 + r_parent);
1000 if (vb->flags & VBLK_FLAG_PART_INDEX)
1001 part->partnum = buffer[0x35 + r_diskid];
1008 * ldm_parse_vol5 - Read a raw VBLK Volume object into a vblk structure
1009 * @buffer: Block of data being worked on
1010 * @buflen: Size of the block of data
1011 * @vb: In-memory vblk in which to return information
1013 * Read a raw VBLK Volume object (version 5) into a vblk structure.
1015 * Return: 'true' @vb contains a Volume VBLK
1016 * 'false' @vb contents are not defined
1018 static bool ldm_parse_vol5(const u8 *buffer, int buflen, struct vblk *vb)
1020 int r_objid, r_name, r_vtype, r_disable_drive_letter, r_child, r_size;
1021 int r_id1, r_id2, r_size2, r_drive, len;
1022 struct vblk_volu *volu;
1024 BUG_ON(!buffer || !vb);
1025 r_objid = ldm_relative(buffer, buflen, 0x18, 0);
1027 ldm_error("r_objid %d < 0", r_objid);
1030 r_name = ldm_relative(buffer, buflen, 0x18, r_objid);
1032 ldm_error("r_name %d < 0", r_name);
1035 r_vtype = ldm_relative(buffer, buflen, 0x18, r_name);
1037 ldm_error("r_vtype %d < 0", r_vtype);
1040 r_disable_drive_letter = ldm_relative(buffer, buflen, 0x18, r_vtype);
1041 if (r_disable_drive_letter < 0) {
1042 ldm_error("r_disable_drive_letter %d < 0",
1043 r_disable_drive_letter);
1046 r_child = ldm_relative(buffer, buflen, 0x2D, r_disable_drive_letter);
1048 ldm_error("r_child %d < 0", r_child);
1051 r_size = ldm_relative(buffer, buflen, 0x3D, r_child);
1053 ldm_error("r_size %d < 0", r_size);
1056 if (buffer[0x12] & VBLK_FLAG_VOLU_ID1) {
1057 r_id1 = ldm_relative(buffer, buflen, 0x52, r_size);
1059 ldm_error("r_id1 %d < 0", r_id1);
1064 if (buffer[0x12] & VBLK_FLAG_VOLU_ID2) {
1065 r_id2 = ldm_relative(buffer, buflen, 0x52, r_id1);
1067 ldm_error("r_id2 %d < 0", r_id2);
1072 if (buffer[0x12] & VBLK_FLAG_VOLU_SIZE) {
1073 r_size2 = ldm_relative(buffer, buflen, 0x52, r_id2);
1075 ldm_error("r_size2 %d < 0", r_size2);
1080 if (buffer[0x12] & VBLK_FLAG_VOLU_DRIVE) {
1081 r_drive = ldm_relative(buffer, buflen, 0x52, r_size2);
1083 ldm_error("r_drive %d < 0", r_drive);
1090 ldm_error("len %d < 0", len);
1093 len += VBLK_SIZE_VOL5;
1094 if (len > get_unaligned_be32(buffer + 0x14)) {
1095 ldm_error("len %d > BE32(buffer + 0x14) %d", len,
1096 get_unaligned_be32(buffer + 0x14));
1099 volu = &vb->vblk.volu;
1100 ldm_get_vstr(buffer + 0x18 + r_name, volu->volume_type,
1101 sizeof(volu->volume_type));
1102 memcpy(volu->volume_state, buffer + 0x18 + r_disable_drive_letter,
1103 sizeof(volu->volume_state));
1104 volu->size = ldm_get_vnum(buffer + 0x3D + r_child);
1105 volu->partition_type = buffer[0x41 + r_size];
1106 memcpy(volu->guid, buffer + 0x42 + r_size, sizeof(volu->guid));
1107 if (buffer[0x12] & VBLK_FLAG_VOLU_DRIVE) {
1108 ldm_get_vstr(buffer + 0x52 + r_size, volu->drive_hint,
1109 sizeof(volu->drive_hint));
1115 * ldm_parse_vblk - Read a raw VBLK object into a vblk structure
1116 * @buf: Block of data being worked on
1117 * @len: Size of the block of data
1118 * @vb: In-memory vblk in which to return information
1120 * Read a raw VBLK object into a vblk structure. This function just reads the
1121 * information common to all VBLK types, then delegates the rest of the work to
1122 * helper functions: ldm_parse_*.
1124 * Return: 'true' @vb contains a VBLK
1125 * 'false' @vb contents are not defined
1127 static bool ldm_parse_vblk (const u8 *buf, int len, struct vblk *vb)
1129 bool result = false;
1132 BUG_ON (!buf || !vb);
1134 r_objid = ldm_relative (buf, len, 0x18, 0);
1136 ldm_error ("VBLK header is corrupt.");
1140 vb->flags = buf[0x12];
1141 vb->type = buf[0x13];
1142 vb->obj_id = ldm_get_vnum (buf + 0x18);
1143 ldm_get_vstr (buf+0x18+r_objid, vb->name, sizeof (vb->name));
1146 case VBLK_CMP3: result = ldm_parse_cmp3 (buf, len, vb); break;
1147 case VBLK_DSK3: result = ldm_parse_dsk3 (buf, len, vb); break;
1148 case VBLK_DSK4: result = ldm_parse_dsk4 (buf, len, vb); break;
1149 case VBLK_DGR3: result = ldm_parse_dgr3 (buf, len, vb); break;
1150 case VBLK_DGR4: result = ldm_parse_dgr4 (buf, len, vb); break;
1151 case VBLK_PRT3: result = ldm_parse_prt3 (buf, len, vb); break;
1152 case VBLK_VOL5: result = ldm_parse_vol5 (buf, len, vb); break;
1156 ldm_debug ("Parsed VBLK 0x%llx (type: 0x%02x) ok.",
1157 (unsigned long long) vb->obj_id, vb->type);
1159 ldm_error ("Failed to parse VBLK 0x%llx (type: 0x%02x).",
1160 (unsigned long long) vb->obj_id, vb->type);
1167 * ldm_ldmdb_add - Adds a raw VBLK entry to the ldmdb database
1168 * @data: Raw VBLK to add to the database
1169 * @len: Size of the raw VBLK
1170 * @ldb: Cache of the database structures
1172 * The VBLKs are sorted into categories. Partitions are also sorted by offset.
1174 * N.B. This function does not check the validity of the VBLKs.
1176 * Return: 'true' The VBLK was added
1177 * 'false' An error occurred
1179 static bool ldm_ldmdb_add (u8 *data, int len, struct ldmdb *ldb)
1182 struct list_head *item;
1184 BUG_ON (!data || !ldb);
1186 vb = kmalloc (sizeof (*vb), GFP_KERNEL);
1188 ldm_crit ("Out of memory.");
1192 if (!ldm_parse_vblk (data, len, vb)) {
1194 return false; /* Already logged */
1197 /* Put vblk into the correct list. */
1201 list_add (&vb->list, &ldb->v_dgrp);
1205 list_add (&vb->list, &ldb->v_disk);
1208 list_add (&vb->list, &ldb->v_volu);
1211 list_add (&vb->list, &ldb->v_comp);
1214 /* Sort by the partition's start sector. */
1215 list_for_each (item, &ldb->v_part) {
1216 struct vblk *v = list_entry (item, struct vblk, list);
1217 if ((v->vblk.part.disk_id == vb->vblk.part.disk_id) &&
1218 (v->vblk.part.start > vb->vblk.part.start)) {
1219 list_add_tail (&vb->list, &v->list);
1223 list_add_tail (&vb->list, &ldb->v_part);
1230 * ldm_frag_add - Add a VBLK fragment to a list
1231 * @data: Raw fragment to be added to the list
1232 * @size: Size of the raw fragment
1233 * @frags: Linked list of VBLK fragments
1235 * Fragmented VBLKs may not be consecutive in the database, so they are placed
1236 * in a list so they can be pieced together later.
1238 * Return: 'true' Success, the VBLK was added to the list
1239 * 'false' Error, a problem occurred
1241 static bool ldm_frag_add (const u8 *data, int size, struct list_head *frags)
1244 struct list_head *item;
1245 int rec, num, group;
1247 BUG_ON (!data || !frags);
1249 if (size < 2 * VBLK_SIZE_HEAD) {
1250 ldm_error("Value of size is to small.");
1254 group = get_unaligned_be32(data + 0x08);
1255 rec = get_unaligned_be16(data + 0x0C);
1256 num = get_unaligned_be16(data + 0x0E);
1257 if ((num < 1) || (num > 4)) {
1258 ldm_error ("A VBLK claims to have %d parts.", num);
1262 ldm_error("REC value (%d) exceeds NUM value (%d)", rec, num);
1266 list_for_each (item, frags) {
1267 f = list_entry (item, struct frag, list);
1268 if (f->group == group)
1272 f = kmalloc (sizeof (*f) + size*num, GFP_KERNEL);
1274 ldm_crit ("Out of memory.");
1281 f->map = 0xFF << num;
1283 list_add_tail (&f->list, frags);
1285 if (rec >= f->num) {
1286 ldm_error("REC value (%d) exceeds NUM value (%d)", rec, f->num);
1289 if (f->map & (1 << rec)) {
1290 ldm_error ("Duplicate VBLK, part %d.", rec);
1291 f->map &= 0x7F; /* Mark the group as broken */
1294 f->map |= (1 << rec);
1296 memcpy(f->data, data, VBLK_SIZE_HEAD);
1297 data += VBLK_SIZE_HEAD;
1298 size -= VBLK_SIZE_HEAD;
1299 memcpy(f->data + VBLK_SIZE_HEAD + rec * size, data, size);
1304 * ldm_frag_free - Free a linked list of VBLK fragments
1305 * @list: Linked list of fragments
1307 * Free a linked list of VBLK fragments
1311 static void ldm_frag_free (struct list_head *list)
1313 struct list_head *item, *tmp;
1317 list_for_each_safe (item, tmp, list)
1318 kfree (list_entry (item, struct frag, list));
1322 * ldm_frag_commit - Validate fragmented VBLKs and add them to the database
1323 * @frags: Linked list of VBLK fragments
1324 * @ldb: Cache of the database structures
1326 * Now that all the fragmented VBLKs have been collected, they must be added to
1327 * the database for later use.
1329 * Return: 'true' All the fragments we added successfully
1330 * 'false' One or more of the fragments we invalid
1332 static bool ldm_frag_commit (struct list_head *frags, struct ldmdb *ldb)
1335 struct list_head *item;
1337 BUG_ON (!frags || !ldb);
1339 list_for_each (item, frags) {
1340 f = list_entry (item, struct frag, list);
1342 if (f->map != 0xFF) {
1343 ldm_error ("VBLK group %d is incomplete (0x%02x).",
1348 if (!ldm_ldmdb_add (f->data, f->num*ldb->vm.vblk_size, ldb))
1349 return false; /* Already logged */
1355 * ldm_get_vblks - Read the on-disk database of VBLKs into memory
1356 * @state: Partition check state including device holding the LDM Database
1357 * @base: Offset, into @state->bdev, of the database
1358 * @ldb: Cache of the database structures
1360 * To use the information from the VBLKs, they need to be read from the disk,
1361 * unpacked and validated. We cache them in @ldb according to their type.
1363 * Return: 'true' All the VBLKs were read successfully
1364 * 'false' An error occurred
1366 static bool ldm_get_vblks(struct parsed_partitions *state, unsigned long base,
1369 int size, perbuf, skip, finish, s, v, recs;
1372 bool result = false;
1375 BUG_ON(!state || !ldb);
1377 size = ldb->vm.vblk_size;
1378 perbuf = 512 / size;
1379 skip = ldb->vm.vblk_offset >> 9; /* Bytes to sectors */
1380 finish = (size * ldb->vm.last_vblk_seq) >> 9;
1382 for (s = skip; s < finish; s++) { /* For each sector */
1383 data = read_part_sector(state, base + OFF_VMDB + s, §);
1385 ldm_crit ("Disk read failed.");
1389 for (v = 0; v < perbuf; v++, data+=size) { /* For each vblk */
1390 if (MAGIC_VBLK != get_unaligned_be32(data)) {
1391 ldm_error ("Expected to find a VBLK.");
1395 recs = get_unaligned_be16(data + 0x0E); /* Number of records */
1397 if (!ldm_ldmdb_add (data, size, ldb))
1398 goto out; /* Already logged */
1399 } else if (recs > 1) {
1400 if (!ldm_frag_add (data, size, &frags))
1401 goto out; /* Already logged */
1403 /* else Record is not in use, ignore it. */
1405 put_dev_sector (sect);
1409 result = ldm_frag_commit (&frags, ldb); /* Failures, already logged */
1412 put_dev_sector (sect);
1413 ldm_frag_free (&frags);
1419 * ldm_free_vblks - Free a linked list of vblk's
1420 * @lh: Head of a linked list of struct vblk
1422 * Free a list of vblk's and free the memory used to maintain the list.
1426 static void ldm_free_vblks (struct list_head *lh)
1428 struct list_head *item, *tmp;
1432 list_for_each_safe (item, tmp, lh)
1433 kfree (list_entry (item, struct vblk, list));
1438 * ldm_partition - Find out whether a device is a dynamic disk and handle it
1439 * @state: Partition check state including device holding the LDM Database
1441 * This determines whether the device @bdev is a dynamic disk and if so creates
1442 * the partitions necessary in the gendisk structure pointed to by @hd.
1444 * We create a dummy device 1, which contains the LDM database, and then create
1445 * each partition described by the LDM database in sequence as devices 2+. For
1446 * example, if the device is hda, we would have: hda1: LDM database, hda2, hda3,
1447 * and so on: the actual data containing partitions.
1449 * Return: 1 Success, @state->bdev is a dynamic disk and we handled it
1450 * 0 Success, @state->bdev is not a dynamic disk
1451 * -1 An error occurred before enough information had been read
1452 * Or @state->bdev is a dynamic disk, but it may be corrupted
1454 int ldm_partition(struct parsed_partitions *state)
1462 /* Look for signs of a Dynamic Disk */
1463 if (!ldm_validate_partition_table(state))
1466 ldb = kmalloc (sizeof (*ldb), GFP_KERNEL);
1468 ldm_crit ("Out of memory.");
1472 /* Parse and check privheads. */
1473 if (!ldm_validate_privheads(state, &ldb->ph))
1474 goto out; /* Already logged */
1476 /* All further references are relative to base (database start). */
1477 base = ldb->ph.config_start;
1479 /* Parse and check tocs and vmdb. */
1480 if (!ldm_validate_tocblocks(state, base, ldb) ||
1481 !ldm_validate_vmdb(state, base, ldb))
1482 goto out; /* Already logged */
1484 /* Initialize vblk lists in ldmdb struct */
1485 INIT_LIST_HEAD (&ldb->v_dgrp);
1486 INIT_LIST_HEAD (&ldb->v_disk);
1487 INIT_LIST_HEAD (&ldb->v_volu);
1488 INIT_LIST_HEAD (&ldb->v_comp);
1489 INIT_LIST_HEAD (&ldb->v_part);
1491 if (!ldm_get_vblks(state, base, ldb)) {
1492 ldm_crit ("Failed to read the VBLKs from the database.");
1496 /* Finally, create the data partition devices. */
1497 if (ldm_create_data_partitions(state, ldb)) {
1498 ldm_debug ("Parsed LDM database successfully.");
1501 /* else Already logged */
1504 ldm_free_vblks (&ldb->v_dgrp);
1505 ldm_free_vblks (&ldb->v_disk);
1506 ldm_free_vblks (&ldb->v_volu);
1507 ldm_free_vblks (&ldb->v_comp);
1508 ldm_free_vblks (&ldb->v_part);