2 * ldm - Support for Windows Logical Disk Manager (Dynamic Disks)
4 * Copyright (C) 2001,2002 Richard Russon <ldm@flatcap.org>
5 * Copyright (c) 2001-2004 Anton Altaparmakov
6 * Copyright (C) 2001,2002 Jakob Kemi <jakob.kemi@telia.com>
8 * Documentation is available at http://linux-ntfs.sf.net/ldm
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>
34 * ldm_debug/info/error/crit - Output an error message
35 * @f: A printf format string containing the message
36 * @...: Variables to substitute into @f
38 * ldm_debug() writes a DEBUG level message to the syslog but only if the
39 * driver was compiled with debug enabled. Otherwise, the call turns into a NOP.
41 #ifndef CONFIG_LDM_DEBUG
42 #define ldm_debug(...) do {} while (0)
44 #define ldm_debug(f, a...) _ldm_printk (KERN_DEBUG, __FUNCTION__, f, ##a)
47 #define ldm_crit(f, a...) _ldm_printk (KERN_CRIT, __FUNCTION__, f, ##a)
48 #define ldm_error(f, a...) _ldm_printk (KERN_ERR, __FUNCTION__, f, ##a)
49 #define ldm_info(f, a...) _ldm_printk (KERN_INFO, __FUNCTION__, f, ##a)
51 __attribute__ ((format (printf, 3, 4)))
52 static void _ldm_printk (const char *level, const char *function,
59 vsnprintf (buf, sizeof (buf), fmt, args);
62 printk ("%s%s(): %s\n", level, function, buf);
67 * ldm_parse_hexbyte - Convert a ASCII hex number to a byte
68 * @src: Pointer to at least 2 characters to convert.
70 * Convert a two character ASCII hex string to a number.
72 * Return: 0-255 Success, the byte was parsed correctly
73 * -1 Error, an invalid character was supplied
75 static int ldm_parse_hexbyte (const u8 *src)
77 unsigned int x; /* For correct wrapping */
81 if ((x = src[0] - '0') <= '9'-'0') h = x;
82 else if ((x = src[0] - 'a') <= 'f'-'a') h = x+10;
83 else if ((x = src[0] - 'A') <= 'F'-'A') h = x+10;
88 if ((x = src[1] - '0') <= '9'-'0') return h | x;
89 if ((x = src[1] - 'a') <= 'f'-'a') return h | (x+10);
90 if ((x = src[1] - 'A') <= 'F'-'A') return h | (x+10);
95 * ldm_parse_guid - Convert GUID from ASCII to binary
96 * @src: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
97 * @dest: Memory block to hold binary GUID (16 bytes)
99 * N.B. The GUID need not be NULL terminated.
101 * Return: 'true' @dest contains binary GUID
102 * 'false' @dest contents are undefined
104 static bool ldm_parse_guid (const u8 *src, u8 *dest)
106 static const int size[] = { 4, 2, 2, 2, 6 };
109 if (src[8] != '-' || src[13] != '-' ||
110 src[18] != '-' || src[23] != '-')
113 for (j = 0; j < 5; j++, src++)
114 for (i = 0; i < size[j]; i++, src+=2, *dest++ = v)
115 if ((v = ldm_parse_hexbyte (src)) < 0)
123 * ldm_parse_privhead - Read the LDM Database PRIVHEAD structure
124 * @data: Raw database PRIVHEAD structure loaded from the device
125 * @ph: In-memory privhead structure in which to return parsed information
127 * This parses the LDM database PRIVHEAD structure supplied in @data and
128 * sets up the in-memory privhead structure @ph with the obtained information.
130 * Return: 'true' @ph contains the PRIVHEAD data
131 * 'false' @ph contents are undefined
133 static bool ldm_parse_privhead (const u8 *data, struct privhead *ph)
135 BUG_ON (!data || !ph);
137 if (MAGIC_PRIVHEAD != BE64 (data)) {
138 ldm_error ("Cannot find PRIVHEAD structure. LDM database is"
139 " corrupt. Aborting.");
143 ph->ver_major = BE16 (data + 0x000C);
144 ph->ver_minor = BE16 (data + 0x000E);
145 ph->logical_disk_start = BE64 (data + 0x011B);
146 ph->logical_disk_size = BE64 (data + 0x0123);
147 ph->config_start = BE64 (data + 0x012B);
148 ph->config_size = BE64 (data + 0x0133);
150 if ((ph->ver_major != 2) || (ph->ver_minor != 11)) {
151 ldm_error ("Expected PRIVHEAD version %d.%d, got %d.%d."
152 " Aborting.", 2, 11, ph->ver_major, ph->ver_minor);
155 if (ph->config_size != LDM_DB_SIZE) { /* 1 MiB in sectors. */
156 /* Warn the user and continue, carefully */
157 ldm_info ("Database is normally %u bytes, it claims to "
158 "be %llu bytes.", LDM_DB_SIZE,
159 (unsigned long long)ph->config_size );
161 if ((ph->logical_disk_size == 0) ||
162 (ph->logical_disk_start + ph->logical_disk_size > ph->config_start)) {
163 ldm_error ("PRIVHEAD disk size doesn't match real disk size");
167 if (!ldm_parse_guid (data + 0x0030, ph->disk_id)) {
168 ldm_error ("PRIVHEAD contains an invalid GUID.");
172 ldm_debug ("Parsed PRIVHEAD successfully.");
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
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
185 * N.B. The *_start and *_size values returned in @toc are not range-checked.
187 * Return: 'true' @toc contains the TOCBLOCK data
188 * 'false' @toc contents are undefined
190 static bool ldm_parse_tocblock (const u8 *data, struct tocblock *toc)
192 BUG_ON (!data || !toc);
194 if (MAGIC_TOCBLOCK != BE64 (data)) {
195 ldm_crit ("Cannot find TOCBLOCK, database may be corrupt.");
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 = BE64 (data + 0x2E);
201 toc->bitmap1_size = BE64 (data + 0x36);
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);
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 = BE64 (data + 0x50);
212 toc->bitmap2_size = 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);
219 ldm_debug ("Parsed TOCBLOCK successfully.");
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
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.
231 * N.B. The *_start, *_size and *_seq values will be range-checked later.
233 * Return: 'true' @vm contains VMDB info
234 * 'false' @vm contents are undefined
236 static bool ldm_parse_vmdb (const u8 *data, struct vmdb *vm)
238 BUG_ON (!data || !vm);
240 if (MAGIC_VMDB != BE32 (data)) {
241 ldm_crit ("Cannot find the VMDB, database may be corrupt.");
245 vm->ver_major = BE16 (data + 0x12);
246 vm->ver_minor = 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);
253 vm->vblk_size = BE32 (data + 0x08);
254 vm->vblk_offset = BE32 (data + 0x0C);
255 vm->last_vblk_seq = BE32 (data + 0x04);
257 ldm_debug ("Parsed VMDB successfully.");
262 * ldm_compare_privheads - Compare two privhead objects
263 * @ph1: First privhead
264 * @ph2: Second privhead
266 * This compares the two privhead structures @ph1 and @ph2.
268 * Return: 'true' Identical
271 static bool ldm_compare_privheads (const struct privhead *ph1,
272 const struct privhead *ph2)
274 BUG_ON (!ph1 || !ph2);
276 return ((ph1->ver_major == ph2->ver_major) &&
277 (ph1->ver_minor == ph2->ver_minor) &&
278 (ph1->logical_disk_start == ph2->logical_disk_start) &&
279 (ph1->logical_disk_size == ph2->logical_disk_size) &&
280 (ph1->config_start == ph2->config_start) &&
281 (ph1->config_size == ph2->config_size) &&
282 !memcmp (ph1->disk_id, ph2->disk_id, GUID_SIZE));
286 * ldm_compare_tocblocks - Compare two tocblock objects
290 * This compares the two tocblock structures @toc1 and @toc2.
292 * Return: 'true' Identical
295 static bool ldm_compare_tocblocks (const struct tocblock *toc1,
296 const struct tocblock *toc2)
298 BUG_ON (!toc1 || !toc2);
300 return ((toc1->bitmap1_start == toc2->bitmap1_start) &&
301 (toc1->bitmap1_size == toc2->bitmap1_size) &&
302 (toc1->bitmap2_start == toc2->bitmap2_start) &&
303 (toc1->bitmap2_size == toc2->bitmap2_size) &&
304 !strncmp (toc1->bitmap1_name, toc2->bitmap1_name,
305 sizeof (toc1->bitmap1_name)) &&
306 !strncmp (toc1->bitmap2_name, toc2->bitmap2_name,
307 sizeof (toc1->bitmap2_name)));
311 * ldm_validate_privheads - Compare the primary privhead with its backups
312 * @bdev: Device holding the LDM Database
313 * @ph1: Memory struct to fill with ph contents
315 * Read and compare all three privheads from disk.
317 * The privheads on disk show the size and location of the main disk area and
318 * the configuration area (the database). The values are range-checked against
319 * @hd, which contains the real size of the disk.
321 * Return: 'true' Success
324 static bool ldm_validate_privheads (struct block_device *bdev,
325 struct privhead *ph1)
327 static const int off[3] = { OFF_PRIV1, OFF_PRIV2, OFF_PRIV3 };
328 struct privhead *ph[3] = { ph1 };
335 BUG_ON (!bdev || !ph1);
337 ph[1] = kmalloc (sizeof (*ph[1]), GFP_KERNEL);
338 ph[2] = kmalloc (sizeof (*ph[2]), GFP_KERNEL);
339 if (!ph[1] || !ph[2]) {
340 ldm_crit ("Out of memory.");
344 /* off[1 & 2] are relative to ph[0]->config_start */
345 ph[0]->config_start = 0;
347 /* Read and parse privheads */
348 for (i = 0; i < 3; i++) {
349 data = read_dev_sector (bdev,
350 ph[0]->config_start + off[i], §);
352 ldm_crit ("Disk read failed.");
355 result = ldm_parse_privhead (data, ph[i]);
356 put_dev_sector (sect);
358 ldm_error ("Cannot find PRIVHEAD %d.", i+1); /* Log again */
360 goto out; /* Already logged */
362 break; /* FIXME ignore for now, 3rd PH can fail on odd-sized disks */
366 num_sects = bdev->bd_inode->i_size >> 9;
368 if ((ph[0]->config_start > num_sects) ||
369 ((ph[0]->config_start + ph[0]->config_size) > num_sects)) {
370 ldm_crit ("Database extends beyond the end of the disk.");
374 if ((ph[0]->logical_disk_start > ph[0]->config_start) ||
375 ((ph[0]->logical_disk_start + ph[0]->logical_disk_size)
376 > ph[0]->config_start)) {
377 ldm_crit ("Disk and database overlap.");
381 if (!ldm_compare_privheads (ph[0], ph[1])) {
382 ldm_crit ("Primary and backup PRIVHEADs don't match.");
385 /* FIXME ignore this for now
386 if (!ldm_compare_privheads (ph[0], ph[2])) {
387 ldm_crit ("Primary and backup PRIVHEADs don't match.");
390 ldm_debug ("Validated PRIVHEADs successfully.");
399 * ldm_validate_tocblocks - Validate the table of contents and its backups
400 * @bdev: Device holding the LDM Database
401 * @base: Offset, into @bdev, of the database
402 * @ldb: Cache of the database structures
404 * Find and compare the four tables of contents of the LDM Database stored on
405 * @bdev and return the parsed information into @toc1.
407 * The offsets and sizes of the configs are range-checked against a privhead.
409 * Return: 'true' @toc1 contains validated TOCBLOCK info
410 * 'false' @toc1 contents are undefined
412 static bool ldm_validate_tocblocks (struct block_device *bdev,
413 unsigned long base, struct ldmdb *ldb)
415 static const int off[4] = { OFF_TOCB1, OFF_TOCB2, OFF_TOCB3, OFF_TOCB4};
416 struct tocblock *tb[4];
423 BUG_ON (!bdev || !ldb);
427 tb[1] = kmalloc (sizeof (*tb[1]), GFP_KERNEL);
428 tb[2] = kmalloc (sizeof (*tb[2]), GFP_KERNEL);
429 tb[3] = kmalloc (sizeof (*tb[3]), GFP_KERNEL);
430 if (!tb[1] || !tb[2] || !tb[3]) {
431 ldm_crit ("Out of memory.");
435 for (i = 0; i < 4; i++) /* Read and parse all four toc's. */
437 data = read_dev_sector (bdev, base + off[i], §);
439 ldm_crit ("Disk read failed.");
442 result = ldm_parse_tocblock (data, tb[i]);
443 put_dev_sector (sect);
445 goto out; /* Already logged */
448 /* Range check the toc against a privhead. */
449 if (((tb[0]->bitmap1_start + tb[0]->bitmap1_size) > ph->config_size) ||
450 ((tb[0]->bitmap2_start + tb[0]->bitmap2_size) > ph->config_size)) {
451 ldm_crit ("The bitmaps are out of range. Giving up.");
455 if (!ldm_compare_tocblocks (tb[0], tb[1]) || /* Compare all tocs. */
456 !ldm_compare_tocblocks (tb[0], tb[2]) ||
457 !ldm_compare_tocblocks (tb[0], tb[3])) {
458 ldm_crit ("The TOCBLOCKs don't match.");
462 ldm_debug ("Validated TOCBLOCKs successfully.");
472 * ldm_validate_vmdb - Read the VMDB and validate it
473 * @bdev: Device holding the LDM Database
474 * @base: Offset, into @bdev, of the database
475 * @ldb: Cache of the database structures
477 * Find the vmdb of the LDM Database stored on @bdev and return the parsed
478 * information in @ldb.
480 * Return: 'true' @ldb contains validated VBDB info
481 * 'false' @ldb contents are undefined
483 static bool ldm_validate_vmdb (struct block_device *bdev, unsigned long base,
490 struct tocblock *toc;
492 BUG_ON (!bdev || !ldb);
497 data = read_dev_sector (bdev, base + OFF_VMDB, §);
499 ldm_crit ("Disk read failed.");
503 if (!ldm_parse_vmdb (data, vm))
504 goto out; /* Already logged */
506 /* Are there uncommitted transactions? */
507 if (BE16(data + 0x10) != 0x01) {
508 ldm_crit ("Database is not in a consistent state. Aborting.");
512 if (vm->vblk_offset != 512)
513 ldm_info ("VBLKs start at offset 0x%04x.", vm->vblk_offset);
516 * The last_vblkd_seq can be before the end of the vmdb, just make sure
517 * it is not out of bounds.
519 if ((vm->vblk_size * vm->last_vblk_seq) > (toc->bitmap1_size << 9)) {
520 ldm_crit ("VMDB exceeds allowed size specified by TOCBLOCK. "
521 "Database is corrupt. Aborting.");
527 put_dev_sector (sect);
533 * ldm_validate_partition_table - Determine whether bdev might be a dynamic disk
534 * @bdev: Device holding the LDM Database
536 * This function provides a weak test to decide whether the device is a dynamic
537 * disk or not. It looks for an MS-DOS-style partition table containing at
538 * least one partition of type 0x42 (formerly SFS, now used by Windows for
541 * N.B. The only possible error can come from the read_dev_sector and that is
542 * only likely to happen if the underlying device is strange. If that IS
543 * the case we should return zero to let someone else try.
545 * Return: 'true' @bdev is a dynamic disk
546 * 'false' @bdev is not a dynamic disk, or an error occurred
548 static bool ldm_validate_partition_table (struct block_device *bdev)
558 data = read_dev_sector (bdev, 0, §);
560 ldm_crit ("Disk read failed.");
564 if (*(__le16*) (data + 0x01FE) != cpu_to_le16 (MSDOS_LABEL_MAGIC))
567 p = (struct partition*)(data + 0x01BE);
568 for (i = 0; i < 4; i++, p++)
569 if (SYS_IND (p) == WIN2K_DYNAMIC_PARTITION) {
575 ldm_debug ("Found W2K dynamic disk partition type.");
578 put_dev_sector (sect);
583 * ldm_get_disk_objid - Search a linked list of vblk's for a given Disk Id
584 * @ldb: Cache of the database structures
586 * The LDM Database contains a list of all partitions on all dynamic disks.
587 * The primary PRIVHEAD, at the beginning of the physical disk, tells us
588 * the GUID of this disk. This function searches for the GUID in a linked
591 * Return: Pointer, A matching vblk was found
592 * NULL, No match, or an error
594 static struct vblk * ldm_get_disk_objid (const struct ldmdb *ldb)
596 struct list_head *item;
600 list_for_each (item, &ldb->v_disk) {
601 struct vblk *v = list_entry (item, struct vblk, list);
602 if (!memcmp (v->vblk.disk.disk_id, ldb->ph.disk_id, GUID_SIZE))
610 * ldm_create_data_partitions - Create data partitions for this device
611 * @pp: List of the partitions parsed so far
612 * @ldb: Cache of the database structures
614 * The database contains ALL the partitions for ALL disk groups, so we need to
615 * filter out this specific disk. Using the disk's object id, we can find all
616 * the partitions in the database that belong to this disk.
618 * Add each partition in our database, to the parsed_partitions structure.
620 * N.B. This function creates the partitions in the order it finds partition
621 * objects in the linked list.
623 * Return: 'true' Partition created
624 * 'false' Error, probably a range checking problem
626 static bool ldm_create_data_partitions (struct parsed_partitions *pp,
627 const struct ldmdb *ldb)
629 struct list_head *item;
632 struct vblk_part *part;
635 BUG_ON (!pp || !ldb);
637 disk = ldm_get_disk_objid (ldb);
639 ldm_crit ("Can't find the ID of this disk in the database.");
645 /* Create the data partitions */
646 list_for_each (item, &ldb->v_part) {
647 vb = list_entry (item, struct vblk, list);
648 part = &vb->vblk.part;
650 if (part->disk_id != disk->obj_id)
653 put_partition (pp, part_num, ldb->ph.logical_disk_start +
654 part->start, part->size);
664 * ldm_relative - Calculate the next relative offset
665 * @buffer: Block of data being worked on
666 * @buflen: Size of the block of data
667 * @base: Size of the previous fixed width fields
668 * @offset: Cumulative size of the previous variable-width fields
670 * Because many of the VBLK fields are variable-width, it's necessary
671 * to calculate each offset based on the previous one and the length
672 * of the field it pointed to.
674 * Return: -1 Error, the calculated offset exceeded the size of the buffer
675 * n OK, a range-checked offset into buffer
677 static int ldm_relative (const u8 *buffer, int buflen, int base, int offset)
681 if ((!buffer) || (offset < 0) || (base > buflen))
683 if ((base + buffer[base]) >= buflen)
686 return buffer[base] + offset + 1;
690 * ldm_get_vnum - Convert a variable-width, big endian number, into cpu order
691 * @block: Pointer to the variable-width number to convert
693 * Large numbers in the LDM Database are often stored in a packed format. Each
694 * number is prefixed by a one byte width marker. All numbers in the database
695 * are stored in big-endian byte order. This function reads one of these
696 * numbers and returns the result
698 * N.B. This function DOES NOT perform any range checking, though the most
699 * it will read is eight bytes.
702 * 0 Zero, or an error occurred
704 static u64 ldm_get_vnum (const u8 *block)
713 if (length && length <= 8)
715 tmp = (tmp << 8) | *block++;
717 ldm_error ("Illegal length %d.", length);
723 * ldm_get_vstr - Read a length-prefixed string into a buffer
724 * @block: Pointer to the length marker
725 * @buffer: Location to copy string to
726 * @buflen: Size of the output buffer
728 * Many of the strings in the LDM Database are not NULL terminated. Instead
729 * they are prefixed by a one byte length marker. This function copies one of
730 * these strings into a buffer.
732 * N.B. This function DOES NOT perform any range checking on the input.
733 * If the buffer is too small, the output will be truncated.
735 * Return: 0, Error and @buffer contents are undefined
736 * n, String length in characters (excluding NULL)
737 * buflen-1, String was truncated.
739 static int ldm_get_vstr (const u8 *block, u8 *buffer, int buflen)
743 BUG_ON (!block || !buffer);
746 if (length >= buflen) {
747 ldm_error ("Truncating string %d -> %d.", length, buflen);
750 memcpy (buffer, block + 1, length);
757 * ldm_parse_cmp3 - Read a raw VBLK Component object into a vblk structure
758 * @buffer: Block of data being worked on
759 * @buflen: Size of the block of data
760 * @vb: In-memory vblk in which to return information
762 * Read a raw VBLK Component object (version 3) into a vblk structure.
764 * Return: 'true' @vb contains a Component VBLK
765 * 'false' @vb contents are not defined
767 static bool ldm_parse_cmp3 (const u8 *buffer, int buflen, struct vblk *vb)
769 int r_objid, r_name, r_vstate, r_child, r_parent, r_stripe, r_cols, len;
770 struct vblk_comp *comp;
772 BUG_ON (!buffer || !vb);
774 r_objid = ldm_relative (buffer, buflen, 0x18, 0);
775 r_name = ldm_relative (buffer, buflen, 0x18, r_objid);
776 r_vstate = ldm_relative (buffer, buflen, 0x18, r_name);
777 r_child = ldm_relative (buffer, buflen, 0x1D, r_vstate);
778 r_parent = ldm_relative (buffer, buflen, 0x2D, r_child);
780 if (buffer[0x12] & VBLK_FLAG_COMP_STRIPE) {
781 r_stripe = ldm_relative (buffer, buflen, 0x2E, r_parent);
782 r_cols = ldm_relative (buffer, buflen, 0x2E, r_stripe);
792 len += VBLK_SIZE_CMP3;
793 if (len != BE32 (buffer + 0x14))
796 comp = &vb->vblk.comp;
797 ldm_get_vstr (buffer + 0x18 + r_name, comp->state,
798 sizeof (comp->state));
799 comp->type = buffer[0x18 + r_vstate];
800 comp->children = ldm_get_vnum (buffer + 0x1D + r_vstate);
801 comp->parent_id = ldm_get_vnum (buffer + 0x2D + r_child);
802 comp->chunksize = r_stripe ? ldm_get_vnum (buffer+r_parent+0x2E) : 0;
808 * ldm_parse_dgr3 - Read a raw VBLK Disk Group object into a vblk structure
809 * @buffer: Block of data being worked on
810 * @buflen: Size of the block of data
811 * @vb: In-memory vblk in which to return information
813 * Read a raw VBLK Disk Group object (version 3) into a vblk structure.
815 * Return: 'true' @vb contains a Disk Group VBLK
816 * 'false' @vb contents are not defined
818 static int ldm_parse_dgr3 (const u8 *buffer, int buflen, struct vblk *vb)
820 int r_objid, r_name, r_diskid, r_id1, r_id2, len;
821 struct vblk_dgrp *dgrp;
823 BUG_ON (!buffer || !vb);
825 r_objid = ldm_relative (buffer, buflen, 0x18, 0);
826 r_name = ldm_relative (buffer, buflen, 0x18, r_objid);
827 r_diskid = ldm_relative (buffer, buflen, 0x18, r_name);
829 if (buffer[0x12] & VBLK_FLAG_DGR3_IDS) {
830 r_id1 = ldm_relative (buffer, buflen, 0x24, r_diskid);
831 r_id2 = ldm_relative (buffer, buflen, 0x24, r_id1);
841 len += VBLK_SIZE_DGR3;
842 if (len != BE32 (buffer + 0x14))
845 dgrp = &vb->vblk.dgrp;
846 ldm_get_vstr (buffer + 0x18 + r_name, dgrp->disk_id,
847 sizeof (dgrp->disk_id));
852 * ldm_parse_dgr4 - Read a raw VBLK Disk Group object into a vblk structure
853 * @buffer: Block of data being worked on
854 * @buflen: Size of the block of data
855 * @vb: In-memory vblk in which to return information
857 * Read a raw VBLK Disk Group object (version 4) into a vblk structure.
859 * Return: 'true' @vb contains a Disk Group VBLK
860 * 'false' @vb contents are not defined
862 static bool ldm_parse_dgr4 (const u8 *buffer, int buflen, struct vblk *vb)
865 int r_objid, r_name, r_id1, r_id2, len;
866 struct vblk_dgrp *dgrp;
868 BUG_ON (!buffer || !vb);
870 r_objid = ldm_relative (buffer, buflen, 0x18, 0);
871 r_name = ldm_relative (buffer, buflen, 0x18, r_objid);
873 if (buffer[0x12] & VBLK_FLAG_DGR4_IDS) {
874 r_id1 = ldm_relative (buffer, buflen, 0x44, r_name);
875 r_id2 = ldm_relative (buffer, buflen, 0x44, r_id1);
885 len += VBLK_SIZE_DGR4;
886 if (len != BE32 (buffer + 0x14))
889 dgrp = &vb->vblk.dgrp;
891 ldm_get_vstr (buffer + 0x18 + r_objid, buf, sizeof (buf));
896 * ldm_parse_dsk3 - Read a raw VBLK Disk object into a vblk structure
897 * @buffer: Block of data being worked on
898 * @buflen: Size of the block of data
899 * @vb: In-memory vblk in which to return information
901 * Read a raw VBLK Disk object (version 3) into a vblk structure.
903 * Return: 'true' @vb contains a Disk VBLK
904 * 'false' @vb contents are not defined
906 static bool ldm_parse_dsk3 (const u8 *buffer, int buflen, struct vblk *vb)
908 int r_objid, r_name, r_diskid, r_altname, len;
909 struct vblk_disk *disk;
911 BUG_ON (!buffer || !vb);
913 r_objid = ldm_relative (buffer, buflen, 0x18, 0);
914 r_name = ldm_relative (buffer, buflen, 0x18, r_objid);
915 r_diskid = ldm_relative (buffer, buflen, 0x18, r_name);
916 r_altname = ldm_relative (buffer, buflen, 0x18, r_diskid);
921 len += VBLK_SIZE_DSK3;
922 if (len != BE32 (buffer + 0x14))
925 disk = &vb->vblk.disk;
926 ldm_get_vstr (buffer + 0x18 + r_diskid, disk->alt_name,
927 sizeof (disk->alt_name));
928 if (!ldm_parse_guid (buffer + 0x19 + r_name, disk->disk_id))
935 * ldm_parse_dsk4 - Read a raw VBLK Disk object into a vblk structure
936 * @buffer: Block of data being worked on
937 * @buflen: Size of the block of data
938 * @vb: In-memory vblk in which to return information
940 * Read a raw VBLK Disk object (version 4) into a vblk structure.
942 * Return: 'true' @vb contains a Disk VBLK
943 * 'false' @vb contents are not defined
945 static bool ldm_parse_dsk4 (const u8 *buffer, int buflen, struct vblk *vb)
947 int r_objid, r_name, len;
948 struct vblk_disk *disk;
950 BUG_ON (!buffer || !vb);
952 r_objid = ldm_relative (buffer, buflen, 0x18, 0);
953 r_name = ldm_relative (buffer, buflen, 0x18, r_objid);
958 len += VBLK_SIZE_DSK4;
959 if (len != BE32 (buffer + 0x14))
962 disk = &vb->vblk.disk;
963 memcpy (disk->disk_id, buffer + 0x18 + r_name, GUID_SIZE);
968 * ldm_parse_prt3 - Read a raw VBLK Partition object into a vblk structure
969 * @buffer: Block of data being worked on
970 * @buflen: Size of the block of data
971 * @vb: In-memory vblk in which to return information
973 * Read a raw VBLK Partition object (version 3) into a vblk structure.
975 * Return: 'true' @vb contains a Partition VBLK
976 * 'false' @vb contents are not defined
978 static bool ldm_parse_prt3 (const u8 *buffer, int buflen, struct vblk *vb)
980 int r_objid, r_name, r_size, r_parent, r_diskid, r_index, len;
981 struct vblk_part *part;
983 BUG_ON (!buffer || !vb);
985 r_objid = ldm_relative (buffer, buflen, 0x18, 0);
986 r_name = ldm_relative (buffer, buflen, 0x18, r_objid);
987 r_size = ldm_relative (buffer, buflen, 0x34, r_name);
988 r_parent = ldm_relative (buffer, buflen, 0x34, r_size);
989 r_diskid = ldm_relative (buffer, buflen, 0x34, r_parent);
991 if (buffer[0x12] & VBLK_FLAG_PART_INDEX) {
992 r_index = ldm_relative (buffer, buflen, 0x34, r_diskid);
1001 len += VBLK_SIZE_PRT3;
1002 if (len != BE32 (buffer + 0x14))
1005 part = &vb->vblk.part;
1006 part->start = BE64 (buffer + 0x24 + r_name);
1007 part->volume_offset = BE64 (buffer + 0x2C + r_name);
1008 part->size = ldm_get_vnum (buffer + 0x34 + r_name);
1009 part->parent_id = ldm_get_vnum (buffer + 0x34 + r_size);
1010 part->disk_id = ldm_get_vnum (buffer + 0x34 + r_parent);
1011 if (vb->flags & VBLK_FLAG_PART_INDEX)
1012 part->partnum = buffer[0x35 + r_diskid];
1020 * ldm_parse_vol5 - Read a raw VBLK Volume object into a vblk structure
1021 * @buffer: Block of data being worked on
1022 * @buflen: Size of the block of data
1023 * @vb: In-memory vblk in which to return information
1025 * Read a raw VBLK Volume object (version 5) into a vblk structure.
1027 * Return: 'true' @vb contains a Volume VBLK
1028 * 'false' @vb contents are not defined
1030 static bool ldm_parse_vol5 (const u8 *buffer, int buflen, struct vblk *vb)
1032 int r_objid, r_name, r_vtype, r_child, r_size, r_id1, r_id2, r_size2;
1034 struct vblk_volu *volu;
1036 BUG_ON (!buffer || !vb);
1038 r_objid = ldm_relative (buffer, buflen, 0x18, 0);
1039 r_name = ldm_relative (buffer, buflen, 0x18, r_objid);
1040 r_vtype = ldm_relative (buffer, buflen, 0x18, r_name);
1041 r_child = ldm_relative (buffer, buflen, 0x2E, r_vtype);
1042 r_size = ldm_relative (buffer, buflen, 0x3E, r_child);
1044 if (buffer[0x12] & VBLK_FLAG_VOLU_ID1)
1045 r_id1 = ldm_relative (buffer, buflen, 0x53, r_size);
1049 if (buffer[0x12] & VBLK_FLAG_VOLU_ID2)
1050 r_id2 = ldm_relative (buffer, buflen, 0x53, r_id1);
1054 if (buffer[0x12] & VBLK_FLAG_VOLU_SIZE)
1055 r_size2 = ldm_relative (buffer, buflen, 0x53, r_id2);
1059 if (buffer[0x12] & VBLK_FLAG_VOLU_DRIVE)
1060 r_drive = ldm_relative (buffer, buflen, 0x53, r_size2);
1068 len += VBLK_SIZE_VOL5;
1069 if (len != BE32 (buffer + 0x14))
1072 volu = &vb->vblk.volu;
1074 ldm_get_vstr (buffer + 0x18 + r_name, volu->volume_type,
1075 sizeof (volu->volume_type));
1076 memcpy (volu->volume_state, buffer + 0x19 + r_vtype,
1077 sizeof (volu->volume_state));
1078 volu->size = ldm_get_vnum (buffer + 0x3E + r_child);
1079 volu->partition_type = buffer[0x42 + r_size];
1080 memcpy (volu->guid, buffer + 0x43 + r_size, sizeof (volu->guid));
1081 if (buffer[0x12] & VBLK_FLAG_VOLU_DRIVE) {
1082 ldm_get_vstr (buffer + 0x53 + r_size, volu->drive_hint,
1083 sizeof (volu->drive_hint));
1089 * ldm_parse_vblk - Read a raw VBLK object into a vblk structure
1090 * @buf: Block of data being worked on
1091 * @len: Size of the block of data
1092 * @vb: In-memory vblk in which to return information
1094 * Read a raw VBLK object into a vblk structure. This function just reads the
1095 * information common to all VBLK types, then delegates the rest of the work to
1096 * helper functions: ldm_parse_*.
1098 * Return: 'true' @vb contains a VBLK
1099 * 'false' @vb contents are not defined
1101 static bool ldm_parse_vblk (const u8 *buf, int len, struct vblk *vb)
1103 bool result = false;
1106 BUG_ON (!buf || !vb);
1108 r_objid = ldm_relative (buf, len, 0x18, 0);
1110 ldm_error ("VBLK header is corrupt.");
1114 vb->flags = buf[0x12];
1115 vb->type = buf[0x13];
1116 vb->obj_id = ldm_get_vnum (buf + 0x18);
1117 ldm_get_vstr (buf+0x18+r_objid, vb->name, sizeof (vb->name));
1120 case VBLK_CMP3: result = ldm_parse_cmp3 (buf, len, vb); break;
1121 case VBLK_DSK3: result = ldm_parse_dsk3 (buf, len, vb); break;
1122 case VBLK_DSK4: result = ldm_parse_dsk4 (buf, len, vb); break;
1123 case VBLK_DGR3: result = ldm_parse_dgr3 (buf, len, vb); break;
1124 case VBLK_DGR4: result = ldm_parse_dgr4 (buf, len, vb); break;
1125 case VBLK_PRT3: result = ldm_parse_prt3 (buf, len, vb); break;
1126 case VBLK_VOL5: result = ldm_parse_vol5 (buf, len, vb); break;
1130 ldm_debug ("Parsed VBLK 0x%llx (type: 0x%02x) ok.",
1131 (unsigned long long) vb->obj_id, vb->type);
1133 ldm_error ("Failed to parse VBLK 0x%llx (type: 0x%02x).",
1134 (unsigned long long) vb->obj_id, vb->type);
1141 * ldm_ldmdb_add - Adds a raw VBLK entry to the ldmdb database
1142 * @data: Raw VBLK to add to the database
1143 * @len: Size of the raw VBLK
1144 * @ldb: Cache of the database structures
1146 * The VBLKs are sorted into categories. Partitions are also sorted by offset.
1148 * N.B. This function does not check the validity of the VBLKs.
1150 * Return: 'true' The VBLK was added
1151 * 'false' An error occurred
1153 static bool ldm_ldmdb_add (u8 *data, int len, struct ldmdb *ldb)
1156 struct list_head *item;
1158 BUG_ON (!data || !ldb);
1160 vb = kmalloc (sizeof (*vb), GFP_KERNEL);
1162 ldm_crit ("Out of memory.");
1166 if (!ldm_parse_vblk (data, len, vb)) {
1168 return false; /* Already logged */
1171 /* Put vblk into the correct list. */
1175 list_add (&vb->list, &ldb->v_dgrp);
1179 list_add (&vb->list, &ldb->v_disk);
1182 list_add (&vb->list, &ldb->v_volu);
1185 list_add (&vb->list, &ldb->v_comp);
1188 /* Sort by the partition's start sector. */
1189 list_for_each (item, &ldb->v_part) {
1190 struct vblk *v = list_entry (item, struct vblk, list);
1191 if ((v->vblk.part.disk_id == vb->vblk.part.disk_id) &&
1192 (v->vblk.part.start > vb->vblk.part.start)) {
1193 list_add_tail (&vb->list, &v->list);
1197 list_add_tail (&vb->list, &ldb->v_part);
1204 * ldm_frag_add - Add a VBLK fragment to a list
1205 * @data: Raw fragment to be added to the list
1206 * @size: Size of the raw fragment
1207 * @frags: Linked list of VBLK fragments
1209 * Fragmented VBLKs may not be consecutive in the database, so they are placed
1210 * in a list so they can be pieced together later.
1212 * Return: 'true' Success, the VBLK was added to the list
1213 * 'false' Error, a problem occurred
1215 static bool ldm_frag_add (const u8 *data, int size, struct list_head *frags)
1218 struct list_head *item;
1219 int rec, num, group;
1221 BUG_ON (!data || !frags);
1223 group = BE32 (data + 0x08);
1224 rec = BE16 (data + 0x0C);
1225 num = BE16 (data + 0x0E);
1226 if ((num < 1) || (num > 4)) {
1227 ldm_error ("A VBLK claims to have %d parts.", num);
1231 list_for_each (item, frags) {
1232 f = list_entry (item, struct frag, list);
1233 if (f->group == group)
1237 f = kmalloc (sizeof (*f) + size*num, GFP_KERNEL);
1239 ldm_crit ("Out of memory.");
1246 f->map = 0xFF << num;
1248 list_add_tail (&f->list, frags);
1250 if (f->map & (1 << rec)) {
1251 ldm_error ("Duplicate VBLK, part %d.", rec);
1252 f->map &= 0x7F; /* Mark the group as broken */
1256 f->map |= (1 << rec);
1259 data += VBLK_SIZE_HEAD;
1260 size -= VBLK_SIZE_HEAD;
1262 memcpy (f->data+rec*(size-VBLK_SIZE_HEAD)+VBLK_SIZE_HEAD, data, size);
1268 * ldm_frag_free - Free a linked list of VBLK fragments
1269 * @list: Linked list of fragments
1271 * Free a linked list of VBLK fragments
1275 static void ldm_frag_free (struct list_head *list)
1277 struct list_head *item, *tmp;
1281 list_for_each_safe (item, tmp, list)
1282 kfree (list_entry (item, struct frag, list));
1286 * ldm_frag_commit - Validate fragmented VBLKs and add them to the database
1287 * @frags: Linked list of VBLK fragments
1288 * @ldb: Cache of the database structures
1290 * Now that all the fragmented VBLKs have been collected, they must be added to
1291 * the database for later use.
1293 * Return: 'true' All the fragments we added successfully
1294 * 'false' One or more of the fragments we invalid
1296 static bool ldm_frag_commit (struct list_head *frags, struct ldmdb *ldb)
1299 struct list_head *item;
1301 BUG_ON (!frags || !ldb);
1303 list_for_each (item, frags) {
1304 f = list_entry (item, struct frag, list);
1306 if (f->map != 0xFF) {
1307 ldm_error ("VBLK group %d is incomplete (0x%02x).",
1312 if (!ldm_ldmdb_add (f->data, f->num*ldb->vm.vblk_size, ldb))
1313 return false; /* Already logged */
1319 * ldm_get_vblks - Read the on-disk database of VBLKs into memory
1320 * @bdev: Device holding the LDM Database
1321 * @base: Offset, into @bdev, of the database
1322 * @ldb: Cache of the database structures
1324 * To use the information from the VBLKs, they need to be read from the disk,
1325 * unpacked and validated. We cache them in @ldb according to their type.
1327 * Return: 'true' All the VBLKs were read successfully
1328 * 'false' An error occurred
1330 static bool ldm_get_vblks (struct block_device *bdev, unsigned long base,
1333 int size, perbuf, skip, finish, s, v, recs;
1336 bool result = false;
1339 BUG_ON (!bdev || !ldb);
1341 size = ldb->vm.vblk_size;
1342 perbuf = 512 / size;
1343 skip = ldb->vm.vblk_offset >> 9; /* Bytes to sectors */
1344 finish = (size * ldb->vm.last_vblk_seq) >> 9;
1346 for (s = skip; s < finish; s++) { /* For each sector */
1347 data = read_dev_sector (bdev, base + OFF_VMDB + s, §);
1349 ldm_crit ("Disk read failed.");
1353 for (v = 0; v < perbuf; v++, data+=size) { /* For each vblk */
1354 if (MAGIC_VBLK != BE32 (data)) {
1355 ldm_error ("Expected to find a VBLK.");
1359 recs = BE16 (data + 0x0E); /* Number of records */
1361 if (!ldm_ldmdb_add (data, size, ldb))
1362 goto out; /* Already logged */
1363 } else if (recs > 1) {
1364 if (!ldm_frag_add (data, size, &frags))
1365 goto out; /* Already logged */
1367 /* else Record is not in use, ignore it. */
1369 put_dev_sector (sect);
1373 result = ldm_frag_commit (&frags, ldb); /* Failures, already logged */
1376 put_dev_sector (sect);
1377 ldm_frag_free (&frags);
1383 * ldm_free_vblks - Free a linked list of vblk's
1384 * @lh: Head of a linked list of struct vblk
1386 * Free a list of vblk's and free the memory used to maintain the list.
1390 static void ldm_free_vblks (struct list_head *lh)
1392 struct list_head *item, *tmp;
1396 list_for_each_safe (item, tmp, lh)
1397 kfree (list_entry (item, struct vblk, list));
1402 * ldm_partition - Find out whether a device is a dynamic disk and handle it
1403 * @pp: List of the partitions parsed so far
1404 * @bdev: Device holding the LDM Database
1406 * This determines whether the device @bdev is a dynamic disk and if so creates
1407 * the partitions necessary in the gendisk structure pointed to by @hd.
1409 * We create a dummy device 1, which contains the LDM database, and then create
1410 * each partition described by the LDM database in sequence as devices 2+. For
1411 * example, if the device is hda, we would have: hda1: LDM database, hda2, hda3,
1412 * and so on: the actual data containing partitions.
1414 * Return: 1 Success, @bdev is a dynamic disk and we handled it
1415 * 0 Success, @bdev is not a dynamic disk
1416 * -1 An error occurred before enough information had been read
1417 * Or @bdev is a dynamic disk, but it may be corrupted
1419 int ldm_partition (struct parsed_partitions *pp, struct block_device *bdev)
1425 BUG_ON (!pp || !bdev);
1427 /* Look for signs of a Dynamic Disk */
1428 if (!ldm_validate_partition_table (bdev))
1431 ldb = kmalloc (sizeof (*ldb), GFP_KERNEL);
1433 ldm_crit ("Out of memory.");
1437 /* Parse and check privheads. */
1438 if (!ldm_validate_privheads (bdev, &ldb->ph))
1439 goto out; /* Already logged */
1441 /* All further references are relative to base (database start). */
1442 base = ldb->ph.config_start;
1444 /* Parse and check tocs and vmdb. */
1445 if (!ldm_validate_tocblocks (bdev, base, ldb) ||
1446 !ldm_validate_vmdb (bdev, base, ldb))
1447 goto out; /* Already logged */
1449 /* Initialize vblk lists in ldmdb struct */
1450 INIT_LIST_HEAD (&ldb->v_dgrp);
1451 INIT_LIST_HEAD (&ldb->v_disk);
1452 INIT_LIST_HEAD (&ldb->v_volu);
1453 INIT_LIST_HEAD (&ldb->v_comp);
1454 INIT_LIST_HEAD (&ldb->v_part);
1456 if (!ldm_get_vblks (bdev, base, ldb)) {
1457 ldm_crit ("Failed to read the VBLKs from the database.");
1461 /* Finally, create the data partition devices. */
1462 if (ldm_create_data_partitions (pp, ldb)) {
1463 ldm_debug ("Parsed LDM database successfully.");
1466 /* else Already logged */
1469 ldm_free_vblks (&ldb->v_dgrp);
1470 ldm_free_vblks (&ldb->v_disk);
1471 ldm_free_vblks (&ldb->v_volu);
1472 ldm_free_vblks (&ldb->v_comp);
1473 ldm_free_vblks (&ldb->v_part);