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>
39 * ldm_debug/info/error/crit - Output an error message
40 * @f: A printf format string containing the message
41 * @...: Variables to substitute into @f
43 * ldm_debug() writes a DEBUG level message to the syslog but only if the
44 * driver was compiled with debug enabled. Otherwise, the call turns into a NOP.
46 #ifndef CONFIG_LDM_DEBUG
47 #define ldm_debug(...) do {} while (0)
49 #define ldm_debug(f, a...) _ldm_printk (KERN_DEBUG, __FUNCTION__, f, ##a)
52 #define ldm_crit(f, a...) _ldm_printk (KERN_CRIT, __FUNCTION__, f, ##a)
53 #define ldm_error(f, a...) _ldm_printk (KERN_ERR, __FUNCTION__, f, ##a)
54 #define ldm_info(f, a...) _ldm_printk (KERN_INFO, __FUNCTION__, f, ##a)
56 __attribute__ ((format (printf
, 3, 4)))
57 static void _ldm_printk (const char *level
, const char *function
,
64 vsnprintf (buf
, sizeof (buf
), fmt
, args
);
67 printk ("%s%s(): %s\n", level
, function
, buf
);
72 * ldm_parse_hexbyte - Convert a ASCII hex number to a byte
73 * @src: Pointer to at least 2 characters to convert.
75 * Convert a two character ASCII hex string to a number.
77 * Return: 0-255 Success, the byte was parsed correctly
78 * -1 Error, an invalid character was supplied
80 static int ldm_parse_hexbyte (const u8
*src
)
82 unsigned int x
; /* For correct wrapping */
86 if ((x
= src
[0] - '0') <= '9'-'0') h
= x
;
87 else if ((x
= src
[0] - 'a') <= 'f'-'a') h
= x
+10;
88 else if ((x
= src
[0] - 'A') <= 'F'-'A') h
= x
+10;
93 if ((x
= src
[1] - '0') <= '9'-'0') return h
| x
;
94 if ((x
= src
[1] - 'a') <= 'f'-'a') return h
| (x
+10);
95 if ((x
= src
[1] - 'A') <= 'F'-'A') return h
| (x
+10);
100 * ldm_parse_guid - Convert GUID from ASCII to binary
101 * @src: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
102 * @dest: Memory block to hold binary GUID (16 bytes)
104 * N.B. The GUID need not be NULL terminated.
106 * Return: TRUE @dest contains binary GUID
107 * FALSE @dest contents are undefined
109 static BOOL
ldm_parse_guid (const u8
*src
, u8
*dest
)
111 static const int size
[] = { 4, 2, 2, 2, 6 };
114 if (src
[8] != '-' || src
[13] != '-' ||
115 src
[18] != '-' || src
[23] != '-')
118 for (j
= 0; j
< 5; j
++, src
++)
119 for (i
= 0; i
< size
[j
]; i
++, src
+=2, *dest
++ = v
)
120 if ((v
= ldm_parse_hexbyte (src
)) < 0)
128 * ldm_parse_privhead - Read the LDM Database PRIVHEAD structure
129 * @data: Raw database PRIVHEAD structure loaded from the device
130 * @ph: In-memory privhead structure in which to return parsed information
132 * This parses the LDM database PRIVHEAD structure supplied in @data and
133 * sets up the in-memory privhead structure @ph with the obtained information.
135 * Return: TRUE @ph contains the PRIVHEAD data
136 * FALSE @ph contents are undefined
138 static BOOL
ldm_parse_privhead (const u8
*data
, struct privhead
*ph
)
140 BUG_ON (!data
|| !ph
);
142 if (MAGIC_PRIVHEAD
!= BE64 (data
)) {
143 ldm_error ("Cannot find PRIVHEAD structure. LDM database is"
144 " corrupt. Aborting.");
148 ph
->ver_major
= BE16 (data
+ 0x000C);
149 ph
->ver_minor
= BE16 (data
+ 0x000E);
150 ph
->logical_disk_start
= BE64 (data
+ 0x011B);
151 ph
->logical_disk_size
= BE64 (data
+ 0x0123);
152 ph
->config_start
= BE64 (data
+ 0x012B);
153 ph
->config_size
= BE64 (data
+ 0x0133);
155 if ((ph
->ver_major
!= 2) || (ph
->ver_minor
!= 11)) {
156 ldm_error ("Expected PRIVHEAD version %d.%d, got %d.%d."
157 " Aborting.", 2, 11, ph
->ver_major
, ph
->ver_minor
);
160 if (ph
->config_size
!= LDM_DB_SIZE
) { /* 1 MiB in sectors. */
161 /* Warn the user and continue, carefully */
162 ldm_info ("Database is normally %u bytes, it claims to "
163 "be %llu bytes.", LDM_DB_SIZE
,
164 (unsigned long long)ph
->config_size
);
166 if ((ph
->logical_disk_size
== 0) ||
167 (ph
->logical_disk_start
+ ph
->logical_disk_size
> ph
->config_start
)) {
168 ldm_error ("PRIVHEAD disk size doesn't match real disk size");
172 if (!ldm_parse_guid (data
+ 0x0030, ph
->disk_id
)) {
173 ldm_error ("PRIVHEAD contains an invalid GUID.");
177 ldm_debug ("Parsed PRIVHEAD successfully.");
182 * ldm_parse_tocblock - Read the LDM Database TOCBLOCK structure
183 * @data: Raw database TOCBLOCK structure loaded from the device
184 * @toc: In-memory toc structure in which to return parsed information
186 * This parses the LDM Database TOCBLOCK (table of contents) structure supplied
187 * in @data and sets up the in-memory tocblock structure @toc with the obtained
190 * N.B. The *_start and *_size values returned in @toc are not range-checked.
192 * Return: TRUE @toc contains the TOCBLOCK data
193 * FALSE @toc contents are undefined
195 static BOOL
ldm_parse_tocblock (const u8
*data
, struct tocblock
*toc
)
197 BUG_ON (!data
|| !toc
);
199 if (MAGIC_TOCBLOCK
!= BE64 (data
)) {
200 ldm_crit ("Cannot find TOCBLOCK, database may be corrupt.");
203 strncpy (toc
->bitmap1_name
, data
+ 0x24, sizeof (toc
->bitmap1_name
));
204 toc
->bitmap1_name
[sizeof (toc
->bitmap1_name
) - 1] = 0;
205 toc
->bitmap1_start
= BE64 (data
+ 0x2E);
206 toc
->bitmap1_size
= BE64 (data
+ 0x36);
208 if (strncmp (toc
->bitmap1_name
, TOC_BITMAP1
,
209 sizeof (toc
->bitmap1_name
)) != 0) {
210 ldm_crit ("TOCBLOCK's first bitmap is '%s', should be '%s'.",
211 TOC_BITMAP1
, toc
->bitmap1_name
);
214 strncpy (toc
->bitmap2_name
, data
+ 0x46, sizeof (toc
->bitmap2_name
));
215 toc
->bitmap2_name
[sizeof (toc
->bitmap2_name
) - 1] = 0;
216 toc
->bitmap2_start
= BE64 (data
+ 0x50);
217 toc
->bitmap2_size
= BE64 (data
+ 0x58);
218 if (strncmp (toc
->bitmap2_name
, TOC_BITMAP2
,
219 sizeof (toc
->bitmap2_name
)) != 0) {
220 ldm_crit ("TOCBLOCK's second bitmap is '%s', should be '%s'.",
221 TOC_BITMAP2
, toc
->bitmap2_name
);
224 ldm_debug ("Parsed TOCBLOCK successfully.");
229 * ldm_parse_vmdb - Read the LDM Database VMDB structure
230 * @data: Raw database VMDB structure loaded from the device
231 * @vm: In-memory vmdb structure in which to return parsed information
233 * This parses the LDM Database VMDB structure supplied in @data and sets up
234 * the in-memory vmdb structure @vm with the obtained information.
236 * N.B. The *_start, *_size and *_seq values will be range-checked later.
238 * Return: TRUE @vm contains VMDB info
239 * FALSE @vm contents are undefined
241 static BOOL
ldm_parse_vmdb (const u8
*data
, struct vmdb
*vm
)
243 BUG_ON (!data
|| !vm
);
245 if (MAGIC_VMDB
!= BE32 (data
)) {
246 ldm_crit ("Cannot find the VMDB, database may be corrupt.");
250 vm
->ver_major
= BE16 (data
+ 0x12);
251 vm
->ver_minor
= BE16 (data
+ 0x14);
252 if ((vm
->ver_major
!= 4) || (vm
->ver_minor
!= 10)) {
253 ldm_error ("Expected VMDB version %d.%d, got %d.%d. "
254 "Aborting.", 4, 10, vm
->ver_major
, vm
->ver_minor
);
258 vm
->vblk_size
= BE32 (data
+ 0x08);
259 vm
->vblk_offset
= BE32 (data
+ 0x0C);
260 vm
->last_vblk_seq
= BE32 (data
+ 0x04);
262 ldm_debug ("Parsed VMDB successfully.");
267 * ldm_compare_privheads - Compare two privhead objects
268 * @ph1: First privhead
269 * @ph2: Second privhead
271 * This compares the two privhead structures @ph1 and @ph2.
273 * Return: TRUE Identical
276 static BOOL
ldm_compare_privheads (const struct privhead
*ph1
,
277 const struct privhead
*ph2
)
279 BUG_ON (!ph1
|| !ph2
);
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
));
291 * ldm_compare_tocblocks - Compare two tocblock objects
295 * This compares the two tocblock structures @toc1 and @toc2.
297 * Return: TRUE Identical
300 static BOOL
ldm_compare_tocblocks (const struct tocblock
*toc1
,
301 const struct tocblock
*toc2
)
303 BUG_ON (!toc1
|| !toc2
);
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
)));
316 * ldm_validate_privheads - Compare the primary privhead with its backups
317 * @bdev: Device holding the LDM Database
318 * @ph1: Memory struct to fill with ph contents
320 * Read and compare all three privheads from disk.
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.
326 * Return: TRUE Success
329 static BOOL
ldm_validate_privheads (struct block_device
*bdev
,
330 struct privhead
*ph1
)
332 static const int off
[3] = { OFF_PRIV1
, OFF_PRIV2
, OFF_PRIV3
};
333 struct privhead
*ph
[3] = { ph1
};
340 BUG_ON (!bdev
|| !ph1
);
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.");
349 /* off[1 & 2] are relative to ph[0]->config_start */
350 ph
[0]->config_start
= 0;
352 /* Read and parse privheads */
353 for (i
= 0; i
< 3; i
++) {
354 data
= read_dev_sector (bdev
,
355 ph
[0]->config_start
+ off
[i
], §
);
357 ldm_crit ("Disk read failed.");
360 result
= ldm_parse_privhead (data
, ph
[i
]);
361 put_dev_sector (sect
);
363 ldm_error ("Cannot find PRIVHEAD %d.", i
+1); /* Log again */
365 goto out
; /* Already logged */
367 break; /* FIXME ignore for now, 3rd PH can fail on odd-sized disks */
371 num_sects
= bdev
->bd_inode
->i_size
>> 9;
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.");
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.");
386 if (!ldm_compare_privheads (ph
[0], ph
[1])) {
387 ldm_crit ("Primary and backup PRIVHEADs don't match.");
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.");
395 ldm_debug ("Validated PRIVHEADs successfully.");
404 * ldm_validate_tocblocks - Validate the table of contents and its backups
405 * @bdev: Device holding the LDM Database
406 * @base: Offset, into @bdev, of the database
407 * @ldb: Cache of the database structures
409 * Find and compare the four tables of contents of the LDM Database stored on
410 * @bdev and return the parsed information into @toc1.
412 * The offsets and sizes of the configs are range-checked against a privhead.
414 * Return: TRUE @toc1 contains validated TOCBLOCK info
415 * FALSE @toc1 contents are undefined
417 static BOOL
ldm_validate_tocblocks (struct block_device
*bdev
,
418 unsigned long base
, struct ldmdb
*ldb
)
420 static const int off
[4] = { OFF_TOCB1
, OFF_TOCB2
, OFF_TOCB3
, OFF_TOCB4
};
421 struct tocblock
*tb
[4];
428 BUG_ON (!bdev
|| !ldb
);
432 tb
[1] = kmalloc (sizeof (*tb
[1]), GFP_KERNEL
);
433 tb
[2] = kmalloc (sizeof (*tb
[2]), GFP_KERNEL
);
434 tb
[3] = kmalloc (sizeof (*tb
[3]), GFP_KERNEL
);
435 if (!tb
[1] || !tb
[2] || !tb
[3]) {
436 ldm_crit ("Out of memory.");
440 for (i
= 0; i
< 4; i
++) /* Read and parse all four toc's. */
442 data
= read_dev_sector (bdev
, base
+ off
[i
], §
);
444 ldm_crit ("Disk read failed.");
447 result
= ldm_parse_tocblock (data
, tb
[i
]);
448 put_dev_sector (sect
);
450 goto out
; /* Already logged */
453 /* Range check the toc against a privhead. */
454 if (((tb
[0]->bitmap1_start
+ tb
[0]->bitmap1_size
) > ph
->config_size
) ||
455 ((tb
[0]->bitmap2_start
+ tb
[0]->bitmap2_size
) > ph
->config_size
)) {
456 ldm_crit ("The bitmaps are out of range. Giving up.");
460 if (!ldm_compare_tocblocks (tb
[0], tb
[1]) || /* Compare all tocs. */
461 !ldm_compare_tocblocks (tb
[0], tb
[2]) ||
462 !ldm_compare_tocblocks (tb
[0], tb
[3])) {
463 ldm_crit ("The TOCBLOCKs don't match.");
467 ldm_debug ("Validated TOCBLOCKs successfully.");
477 * ldm_validate_vmdb - Read the VMDB and validate it
478 * @bdev: Device holding the LDM Database
479 * @base: Offset, into @bdev, of the database
480 * @ldb: Cache of the database structures
482 * Find the vmdb of the LDM Database stored on @bdev and return the parsed
483 * information in @ldb.
485 * Return: TRUE @ldb contains validated VBDB info
486 * FALSE @ldb contents are undefined
488 static BOOL
ldm_validate_vmdb (struct block_device
*bdev
, unsigned long base
,
495 struct tocblock
*toc
;
497 BUG_ON (!bdev
|| !ldb
);
502 data
= read_dev_sector (bdev
, base
+ OFF_VMDB
, §
);
504 ldm_crit ("Disk read failed.");
508 if (!ldm_parse_vmdb (data
, vm
))
509 goto out
; /* Already logged */
511 /* Are there uncommitted transactions? */
512 if (BE16(data
+ 0x10) != 0x01) {
513 ldm_crit ("Database is not in a consistent state. Aborting.");
517 if (vm
->vblk_offset
!= 512)
518 ldm_info ("VBLKs start at offset 0x%04x.", vm
->vblk_offset
);
521 * The last_vblkd_seq can be before the end of the vmdb, just make sure
522 * it is not out of bounds.
524 if ((vm
->vblk_size
* vm
->last_vblk_seq
) > (toc
->bitmap1_size
<< 9)) {
525 ldm_crit ("VMDB exceeds allowed size specified by TOCBLOCK. "
526 "Database is corrupt. Aborting.");
532 put_dev_sector (sect
);
538 * ldm_validate_partition_table - Determine whether bdev might be a dynamic disk
539 * @bdev: Device holding the LDM Database
541 * This function provides a weak test to decide whether the device is a dynamic
542 * disk or not. It looks for an MS-DOS-style partition table containing at
543 * least one partition of type 0x42 (formerly SFS, now used by Windows for
546 * N.B. The only possible error can come from the read_dev_sector and that is
547 * only likely to happen if the underlying device is strange. If that IS
548 * the case we should return zero to let someone else try.
550 * Return: TRUE @bdev is a dynamic disk
551 * FALSE @bdev is not a dynamic disk, or an error occurred
553 static BOOL
ldm_validate_partition_table (struct block_device
*bdev
)
563 data
= read_dev_sector (bdev
, 0, §
);
565 ldm_crit ("Disk read failed.");
569 if (*(__le16
*) (data
+ 0x01FE) != cpu_to_le16 (MSDOS_LABEL_MAGIC
))
572 p
= (struct partition
*)(data
+ 0x01BE);
573 for (i
= 0; i
< 4; i
++, p
++)
574 if (SYS_IND (p
) == WIN2K_DYNAMIC_PARTITION
) {
580 ldm_debug ("Found W2K dynamic disk partition type.");
583 put_dev_sector (sect
);
588 * ldm_get_disk_objid - Search a linked list of vblk's for a given Disk Id
589 * @ldb: Cache of the database structures
591 * The LDM Database contains a list of all partitions on all dynamic disks.
592 * The primary PRIVHEAD, at the beginning of the physical disk, tells us
593 * the GUID of this disk. This function searches for the GUID in a linked
596 * Return: Pointer, A matching vblk was found
597 * NULL, No match, or an error
599 static struct vblk
* ldm_get_disk_objid (const struct ldmdb
*ldb
)
601 struct list_head
*item
;
605 list_for_each (item
, &ldb
->v_disk
) {
606 struct vblk
*v
= list_entry (item
, struct vblk
, list
);
607 if (!memcmp (v
->vblk
.disk
.disk_id
, ldb
->ph
.disk_id
, GUID_SIZE
))
615 * ldm_create_data_partitions - Create data partitions for this device
616 * @pp: List of the partitions parsed so far
617 * @ldb: Cache of the database structures
619 * The database contains ALL the partitions for ALL disk groups, so we need to
620 * filter out this specific disk. Using the disk's object id, we can find all
621 * the partitions in the database that belong to this disk.
623 * Add each partition in our database, to the parsed_partitions structure.
625 * N.B. This function creates the partitions in the order it finds partition
626 * objects in the linked list.
628 * Return: TRUE Partition created
629 * FALSE Error, probably a range checking problem
631 static BOOL
ldm_create_data_partitions (struct parsed_partitions
*pp
,
632 const struct ldmdb
*ldb
)
634 struct list_head
*item
;
637 struct vblk_part
*part
;
640 BUG_ON (!pp
|| !ldb
);
642 disk
= ldm_get_disk_objid (ldb
);
644 ldm_crit ("Can't find the ID of this disk in the database.");
650 /* Create the data partitions */
651 list_for_each (item
, &ldb
->v_part
) {
652 vb
= list_entry (item
, struct vblk
, list
);
653 part
= &vb
->vblk
.part
;
655 if (part
->disk_id
!= disk
->obj_id
)
658 put_partition (pp
, part_num
, ldb
->ph
.logical_disk_start
+
659 part
->start
, part
->size
);
669 * ldm_relative - Calculate the next relative offset
670 * @buffer: Block of data being worked on
671 * @buflen: Size of the block of data
672 * @base: Size of the previous fixed width fields
673 * @offset: Cumulative size of the previous variable-width fields
675 * Because many of the VBLK fields are variable-width, it's necessary
676 * to calculate each offset based on the previous one and the length
677 * of the field it pointed to.
679 * Return: -1 Error, the calculated offset exceeded the size of the buffer
680 * n OK, a range-checked offset into buffer
682 static int ldm_relative (const u8
*buffer
, int buflen
, int base
, int offset
)
686 if ((!buffer
) || (offset
< 0) || (base
> buflen
))
688 if ((base
+ buffer
[base
]) >= buflen
)
691 return buffer
[base
] + offset
+ 1;
695 * ldm_get_vnum - Convert a variable-width, big endian number, into cpu order
696 * @block: Pointer to the variable-width number to convert
698 * Large numbers in the LDM Database are often stored in a packed format. Each
699 * number is prefixed by a one byte width marker. All numbers in the database
700 * are stored in big-endian byte order. This function reads one of these
701 * numbers and returns the result
703 * N.B. This function DOES NOT perform any range checking, though the most
704 * it will read is eight bytes.
707 * 0 Zero, or an error occurred
709 static u64
ldm_get_vnum (const u8
*block
)
718 if (length
&& length
<= 8)
720 tmp
= (tmp
<< 8) | *block
++;
722 ldm_error ("Illegal length %d.", length
);
728 * ldm_get_vstr - Read a length-prefixed string into a buffer
729 * @block: Pointer to the length marker
730 * @buffer: Location to copy string to
731 * @buflen: Size of the output buffer
733 * Many of the strings in the LDM Database are not NULL terminated. Instead
734 * they are prefixed by a one byte length marker. This function copies one of
735 * these strings into a buffer.
737 * N.B. This function DOES NOT perform any range checking on the input.
738 * If the buffer is too small, the output will be truncated.
740 * Return: 0, Error and @buffer contents are undefined
741 * n, String length in characters (excluding NULL)
742 * buflen-1, String was truncated.
744 static int ldm_get_vstr (const u8
*block
, u8
*buffer
, int buflen
)
748 BUG_ON (!block
|| !buffer
);
751 if (length
>= buflen
) {
752 ldm_error ("Truncating string %d -> %d.", length
, buflen
);
755 memcpy (buffer
, block
+ 1, length
);
762 * ldm_parse_cmp3 - Read a raw VBLK Component object into a vblk structure
763 * @buffer: Block of data being worked on
764 * @buflen: Size of the block of data
765 * @vb: In-memory vblk in which to return information
767 * Read a raw VBLK Component object (version 3) into a vblk structure.
769 * Return: TRUE @vb contains a Component VBLK
770 * FALSE @vb contents are not defined
772 static BOOL
ldm_parse_cmp3 (const u8
*buffer
, int buflen
, struct vblk
*vb
)
774 int r_objid
, r_name
, r_vstate
, r_child
, r_parent
, r_stripe
, r_cols
, len
;
775 struct vblk_comp
*comp
;
777 BUG_ON (!buffer
|| !vb
);
779 r_objid
= ldm_relative (buffer
, buflen
, 0x18, 0);
780 r_name
= ldm_relative (buffer
, buflen
, 0x18, r_objid
);
781 r_vstate
= ldm_relative (buffer
, buflen
, 0x18, r_name
);
782 r_child
= ldm_relative (buffer
, buflen
, 0x1D, r_vstate
);
783 r_parent
= ldm_relative (buffer
, buflen
, 0x2D, r_child
);
785 if (buffer
[0x12] & VBLK_FLAG_COMP_STRIPE
) {
786 r_stripe
= ldm_relative (buffer
, buflen
, 0x2E, r_parent
);
787 r_cols
= ldm_relative (buffer
, buflen
, 0x2E, r_stripe
);
797 len
+= VBLK_SIZE_CMP3
;
798 if (len
!= BE32 (buffer
+ 0x14))
801 comp
= &vb
->vblk
.comp
;
802 ldm_get_vstr (buffer
+ 0x18 + r_name
, comp
->state
,
803 sizeof (comp
->state
));
804 comp
->type
= buffer
[0x18 + r_vstate
];
805 comp
->children
= ldm_get_vnum (buffer
+ 0x1D + r_vstate
);
806 comp
->parent_id
= ldm_get_vnum (buffer
+ 0x2D + r_child
);
807 comp
->chunksize
= r_stripe
? ldm_get_vnum (buffer
+r_parent
+0x2E) : 0;
813 * ldm_parse_dgr3 - Read a raw VBLK Disk Group object into a vblk structure
814 * @buffer: Block of data being worked on
815 * @buflen: Size of the block of data
816 * @vb: In-memory vblk in which to return information
818 * Read a raw VBLK Disk Group object (version 3) into a vblk structure.
820 * Return: TRUE @vb contains a Disk Group VBLK
821 * FALSE @vb contents are not defined
823 static int ldm_parse_dgr3 (const u8
*buffer
, int buflen
, struct vblk
*vb
)
825 int r_objid
, r_name
, r_diskid
, r_id1
, r_id2
, len
;
826 struct vblk_dgrp
*dgrp
;
828 BUG_ON (!buffer
|| !vb
);
830 r_objid
= ldm_relative (buffer
, buflen
, 0x18, 0);
831 r_name
= ldm_relative (buffer
, buflen
, 0x18, r_objid
);
832 r_diskid
= ldm_relative (buffer
, buflen
, 0x18, r_name
);
834 if (buffer
[0x12] & VBLK_FLAG_DGR3_IDS
) {
835 r_id1
= ldm_relative (buffer
, buflen
, 0x24, r_diskid
);
836 r_id2
= ldm_relative (buffer
, buflen
, 0x24, r_id1
);
846 len
+= VBLK_SIZE_DGR3
;
847 if (len
!= BE32 (buffer
+ 0x14))
850 dgrp
= &vb
->vblk
.dgrp
;
851 ldm_get_vstr (buffer
+ 0x18 + r_name
, dgrp
->disk_id
,
852 sizeof (dgrp
->disk_id
));
857 * ldm_parse_dgr4 - Read a raw VBLK Disk Group object into a vblk structure
858 * @buffer: Block of data being worked on
859 * @buflen: Size of the block of data
860 * @vb: In-memory vblk in which to return information
862 * Read a raw VBLK Disk Group object (version 4) into a vblk structure.
864 * Return: TRUE @vb contains a Disk Group VBLK
865 * FALSE @vb contents are not defined
867 static BOOL
ldm_parse_dgr4 (const u8
*buffer
, int buflen
, struct vblk
*vb
)
870 int r_objid
, r_name
, r_id1
, r_id2
, len
;
871 struct vblk_dgrp
*dgrp
;
873 BUG_ON (!buffer
|| !vb
);
875 r_objid
= ldm_relative (buffer
, buflen
, 0x18, 0);
876 r_name
= ldm_relative (buffer
, buflen
, 0x18, r_objid
);
878 if (buffer
[0x12] & VBLK_FLAG_DGR4_IDS
) {
879 r_id1
= ldm_relative (buffer
, buflen
, 0x44, r_name
);
880 r_id2
= ldm_relative (buffer
, buflen
, 0x44, r_id1
);
890 len
+= VBLK_SIZE_DGR4
;
891 if (len
!= BE32 (buffer
+ 0x14))
894 dgrp
= &vb
->vblk
.dgrp
;
896 ldm_get_vstr (buffer
+ 0x18 + r_objid
, buf
, sizeof (buf
));
901 * ldm_parse_dsk3 - Read a raw VBLK Disk object into a vblk structure
902 * @buffer: Block of data being worked on
903 * @buflen: Size of the block of data
904 * @vb: In-memory vblk in which to return information
906 * Read a raw VBLK Disk object (version 3) into a vblk structure.
908 * Return: TRUE @vb contains a Disk VBLK
909 * FALSE @vb contents are not defined
911 static BOOL
ldm_parse_dsk3 (const u8
*buffer
, int buflen
, struct vblk
*vb
)
913 int r_objid
, r_name
, r_diskid
, r_altname
, len
;
914 struct vblk_disk
*disk
;
916 BUG_ON (!buffer
|| !vb
);
918 r_objid
= ldm_relative (buffer
, buflen
, 0x18, 0);
919 r_name
= ldm_relative (buffer
, buflen
, 0x18, r_objid
);
920 r_diskid
= ldm_relative (buffer
, buflen
, 0x18, r_name
);
921 r_altname
= ldm_relative (buffer
, buflen
, 0x18, r_diskid
);
926 len
+= VBLK_SIZE_DSK3
;
927 if (len
!= BE32 (buffer
+ 0x14))
930 disk
= &vb
->vblk
.disk
;
931 ldm_get_vstr (buffer
+ 0x18 + r_diskid
, disk
->alt_name
,
932 sizeof (disk
->alt_name
));
933 if (!ldm_parse_guid (buffer
+ 0x19 + r_name
, disk
->disk_id
))
940 * ldm_parse_dsk4 - Read a raw VBLK Disk object into a vblk structure
941 * @buffer: Block of data being worked on
942 * @buflen: Size of the block of data
943 * @vb: In-memory vblk in which to return information
945 * Read a raw VBLK Disk object (version 4) into a vblk structure.
947 * Return: TRUE @vb contains a Disk VBLK
948 * FALSE @vb contents are not defined
950 static BOOL
ldm_parse_dsk4 (const u8
*buffer
, int buflen
, struct vblk
*vb
)
952 int r_objid
, r_name
, len
;
953 struct vblk_disk
*disk
;
955 BUG_ON (!buffer
|| !vb
);
957 r_objid
= ldm_relative (buffer
, buflen
, 0x18, 0);
958 r_name
= ldm_relative (buffer
, buflen
, 0x18, r_objid
);
963 len
+= VBLK_SIZE_DSK4
;
964 if (len
!= BE32 (buffer
+ 0x14))
967 disk
= &vb
->vblk
.disk
;
968 memcpy (disk
->disk_id
, buffer
+ 0x18 + r_name
, GUID_SIZE
);
973 * ldm_parse_prt3 - Read a raw VBLK Partition object into a vblk structure
974 * @buffer: Block of data being worked on
975 * @buflen: Size of the block of data
976 * @vb: In-memory vblk in which to return information
978 * Read a raw VBLK Partition object (version 3) into a vblk structure.
980 * Return: TRUE @vb contains a Partition VBLK
981 * FALSE @vb contents are not defined
983 static BOOL
ldm_parse_prt3 (const u8
*buffer
, int buflen
, struct vblk
*vb
)
985 int r_objid
, r_name
, r_size
, r_parent
, r_diskid
, r_index
, len
;
986 struct vblk_part
*part
;
988 BUG_ON (!buffer
|| !vb
);
990 r_objid
= ldm_relative (buffer
, buflen
, 0x18, 0);
991 r_name
= ldm_relative (buffer
, buflen
, 0x18, r_objid
);
992 r_size
= ldm_relative (buffer
, buflen
, 0x34, r_name
);
993 r_parent
= ldm_relative (buffer
, buflen
, 0x34, r_size
);
994 r_diskid
= ldm_relative (buffer
, buflen
, 0x34, r_parent
);
996 if (buffer
[0x12] & VBLK_FLAG_PART_INDEX
) {
997 r_index
= ldm_relative (buffer
, buflen
, 0x34, r_diskid
);
1006 len
+= VBLK_SIZE_PRT3
;
1007 if (len
!= BE32 (buffer
+ 0x14))
1010 part
= &vb
->vblk
.part
;
1011 part
->start
= BE64 (buffer
+ 0x24 + r_name
);
1012 part
->volume_offset
= BE64 (buffer
+ 0x2C + r_name
);
1013 part
->size
= ldm_get_vnum (buffer
+ 0x34 + r_name
);
1014 part
->parent_id
= ldm_get_vnum (buffer
+ 0x34 + r_size
);
1015 part
->disk_id
= ldm_get_vnum (buffer
+ 0x34 + r_parent
);
1016 if (vb
->flags
& VBLK_FLAG_PART_INDEX
)
1017 part
->partnum
= buffer
[0x35 + r_diskid
];
1025 * ldm_parse_vol5 - Read a raw VBLK Volume object into a vblk structure
1026 * @buffer: Block of data being worked on
1027 * @buflen: Size of the block of data
1028 * @vb: In-memory vblk in which to return information
1030 * Read a raw VBLK Volume object (version 5) into a vblk structure.
1032 * Return: TRUE @vb contains a Volume VBLK
1033 * FALSE @vb contents are not defined
1035 static BOOL
ldm_parse_vol5 (const u8
*buffer
, int buflen
, struct vblk
*vb
)
1037 int r_objid
, r_name
, r_vtype
, r_child
, r_size
, r_id1
, r_id2
, r_size2
;
1039 struct vblk_volu
*volu
;
1041 BUG_ON (!buffer
|| !vb
);
1043 r_objid
= ldm_relative (buffer
, buflen
, 0x18, 0);
1044 r_name
= ldm_relative (buffer
, buflen
, 0x18, r_objid
);
1045 r_vtype
= ldm_relative (buffer
, buflen
, 0x18, r_name
);
1046 r_child
= ldm_relative (buffer
, buflen
, 0x2E, r_vtype
);
1047 r_size
= ldm_relative (buffer
, buflen
, 0x3E, r_child
);
1049 if (buffer
[0x12] & VBLK_FLAG_VOLU_ID1
)
1050 r_id1
= ldm_relative (buffer
, buflen
, 0x53, r_size
);
1054 if (buffer
[0x12] & VBLK_FLAG_VOLU_ID2
)
1055 r_id2
= ldm_relative (buffer
, buflen
, 0x53, r_id1
);
1059 if (buffer
[0x12] & VBLK_FLAG_VOLU_SIZE
)
1060 r_size2
= ldm_relative (buffer
, buflen
, 0x53, r_id2
);
1064 if (buffer
[0x12] & VBLK_FLAG_VOLU_DRIVE
)
1065 r_drive
= ldm_relative (buffer
, buflen
, 0x53, r_size2
);
1073 len
+= VBLK_SIZE_VOL5
;
1074 if (len
!= BE32 (buffer
+ 0x14))
1077 volu
= &vb
->vblk
.volu
;
1079 ldm_get_vstr (buffer
+ 0x18 + r_name
, volu
->volume_type
,
1080 sizeof (volu
->volume_type
));
1081 memcpy (volu
->volume_state
, buffer
+ 0x19 + r_vtype
,
1082 sizeof (volu
->volume_state
));
1083 volu
->size
= ldm_get_vnum (buffer
+ 0x3E + r_child
);
1084 volu
->partition_type
= buffer
[0x42 + r_size
];
1085 memcpy (volu
->guid
, buffer
+ 0x43 + r_size
, sizeof (volu
->guid
));
1086 if (buffer
[0x12] & VBLK_FLAG_VOLU_DRIVE
) {
1087 ldm_get_vstr (buffer
+ 0x53 + r_size
, volu
->drive_hint
,
1088 sizeof (volu
->drive_hint
));
1094 * ldm_parse_vblk - Read a raw VBLK object into a vblk structure
1095 * @buf: Block of data being worked on
1096 * @len: Size of the block of data
1097 * @vb: In-memory vblk in which to return information
1099 * Read a raw VBLK object into a vblk structure. This function just reads the
1100 * information common to all VBLK types, then delegates the rest of the work to
1101 * helper functions: ldm_parse_*.
1103 * Return: TRUE @vb contains a VBLK
1104 * FALSE @vb contents are not defined
1106 static BOOL
ldm_parse_vblk (const u8
*buf
, int len
, struct vblk
*vb
)
1108 BOOL result
= FALSE
;
1111 BUG_ON (!buf
|| !vb
);
1113 r_objid
= ldm_relative (buf
, len
, 0x18, 0);
1115 ldm_error ("VBLK header is corrupt.");
1119 vb
->flags
= buf
[0x12];
1120 vb
->type
= buf
[0x13];
1121 vb
->obj_id
= ldm_get_vnum (buf
+ 0x18);
1122 ldm_get_vstr (buf
+0x18+r_objid
, vb
->name
, sizeof (vb
->name
));
1125 case VBLK_CMP3
: result
= ldm_parse_cmp3 (buf
, len
, vb
); break;
1126 case VBLK_DSK3
: result
= ldm_parse_dsk3 (buf
, len
, vb
); break;
1127 case VBLK_DSK4
: result
= ldm_parse_dsk4 (buf
, len
, vb
); break;
1128 case VBLK_DGR3
: result
= ldm_parse_dgr3 (buf
, len
, vb
); break;
1129 case VBLK_DGR4
: result
= ldm_parse_dgr4 (buf
, len
, vb
); break;
1130 case VBLK_PRT3
: result
= ldm_parse_prt3 (buf
, len
, vb
); break;
1131 case VBLK_VOL5
: result
= ldm_parse_vol5 (buf
, len
, vb
); break;
1135 ldm_debug ("Parsed VBLK 0x%llx (type: 0x%02x) ok.",
1136 (unsigned long long) vb
->obj_id
, vb
->type
);
1138 ldm_error ("Failed to parse VBLK 0x%llx (type: 0x%02x).",
1139 (unsigned long long) vb
->obj_id
, vb
->type
);
1146 * ldm_ldmdb_add - Adds a raw VBLK entry to the ldmdb database
1147 * @data: Raw VBLK to add to the database
1148 * @len: Size of the raw VBLK
1149 * @ldb: Cache of the database structures
1151 * The VBLKs are sorted into categories. Partitions are also sorted by offset.
1153 * N.B. This function does not check the validity of the VBLKs.
1155 * Return: TRUE The VBLK was added
1156 * FALSE An error occurred
1158 static BOOL
ldm_ldmdb_add (u8
*data
, int len
, struct ldmdb
*ldb
)
1161 struct list_head
*item
;
1163 BUG_ON (!data
|| !ldb
);
1165 vb
= kmalloc (sizeof (*vb
), GFP_KERNEL
);
1167 ldm_crit ("Out of memory.");
1171 if (!ldm_parse_vblk (data
, len
, vb
)) {
1173 return FALSE
; /* Already logged */
1176 /* Put vblk into the correct list. */
1180 list_add (&vb
->list
, &ldb
->v_dgrp
);
1184 list_add (&vb
->list
, &ldb
->v_disk
);
1187 list_add (&vb
->list
, &ldb
->v_volu
);
1190 list_add (&vb
->list
, &ldb
->v_comp
);
1193 /* Sort by the partition's start sector. */
1194 list_for_each (item
, &ldb
->v_part
) {
1195 struct vblk
*v
= list_entry (item
, struct vblk
, list
);
1196 if ((v
->vblk
.part
.disk_id
== vb
->vblk
.part
.disk_id
) &&
1197 (v
->vblk
.part
.start
> vb
->vblk
.part
.start
)) {
1198 list_add_tail (&vb
->list
, &v
->list
);
1202 list_add_tail (&vb
->list
, &ldb
->v_part
);
1209 * ldm_frag_add - Add a VBLK fragment to a list
1210 * @data: Raw fragment to be added to the list
1211 * @size: Size of the raw fragment
1212 * @frags: Linked list of VBLK fragments
1214 * Fragmented VBLKs may not be consecutive in the database, so they are placed
1215 * in a list so they can be pieced together later.
1217 * Return: TRUE Success, the VBLK was added to the list
1218 * FALSE Error, a problem occurred
1220 static BOOL
ldm_frag_add (const u8
*data
, int size
, struct list_head
*frags
)
1223 struct list_head
*item
;
1224 int rec
, num
, group
;
1226 BUG_ON (!data
|| !frags
);
1228 group
= BE32 (data
+ 0x08);
1229 rec
= BE16 (data
+ 0x0C);
1230 num
= BE16 (data
+ 0x0E);
1231 if ((num
< 1) || (num
> 4)) {
1232 ldm_error ("A VBLK claims to have %d parts.", num
);
1236 list_for_each (item
, frags
) {
1237 f
= list_entry (item
, struct frag
, list
);
1238 if (f
->group
== group
)
1242 f
= kmalloc (sizeof (*f
) + size
*num
, GFP_KERNEL
);
1244 ldm_crit ("Out of memory.");
1251 f
->map
= 0xFF << num
;
1253 list_add_tail (&f
->list
, frags
);
1255 if (f
->map
& (1 << rec
)) {
1256 ldm_error ("Duplicate VBLK, part %d.", rec
);
1257 f
->map
&= 0x7F; /* Mark the group as broken */
1261 f
->map
|= (1 << rec
);
1264 data
+= VBLK_SIZE_HEAD
;
1265 size
-= VBLK_SIZE_HEAD
;
1267 memcpy (f
->data
+rec
*(size
-VBLK_SIZE_HEAD
)+VBLK_SIZE_HEAD
, data
, size
);
1273 * ldm_frag_free - Free a linked list of VBLK fragments
1274 * @list: Linked list of fragments
1276 * Free a linked list of VBLK fragments
1280 static void ldm_frag_free (struct list_head
*list
)
1282 struct list_head
*item
, *tmp
;
1286 list_for_each_safe (item
, tmp
, list
)
1287 kfree (list_entry (item
, struct frag
, list
));
1291 * ldm_frag_commit - Validate fragmented VBLKs and add them to the database
1292 * @frags: Linked list of VBLK fragments
1293 * @ldb: Cache of the database structures
1295 * Now that all the fragmented VBLKs have been collected, they must be added to
1296 * the database for later use.
1298 * Return: TRUE All the fragments we added successfully
1299 * FALSE One or more of the fragments we invalid
1301 static BOOL
ldm_frag_commit (struct list_head
*frags
, struct ldmdb
*ldb
)
1304 struct list_head
*item
;
1306 BUG_ON (!frags
|| !ldb
);
1308 list_for_each (item
, frags
) {
1309 f
= list_entry (item
, struct frag
, list
);
1311 if (f
->map
!= 0xFF) {
1312 ldm_error ("VBLK group %d is incomplete (0x%02x).",
1317 if (!ldm_ldmdb_add (f
->data
, f
->num
*ldb
->vm
.vblk_size
, ldb
))
1318 return FALSE
; /* Already logged */
1324 * ldm_get_vblks - Read the on-disk database of VBLKs into memory
1325 * @bdev: Device holding the LDM Database
1326 * @base: Offset, into @bdev, of the database
1327 * @ldb: Cache of the database structures
1329 * To use the information from the VBLKs, they need to be read from the disk,
1330 * unpacked and validated. We cache them in @ldb according to their type.
1332 * Return: TRUE All the VBLKs were read successfully
1333 * FALSE An error occurred
1335 static BOOL
ldm_get_vblks (struct block_device
*bdev
, unsigned long base
,
1338 int size
, perbuf
, skip
, finish
, s
, v
, recs
;
1341 BOOL result
= FALSE
;
1344 BUG_ON (!bdev
|| !ldb
);
1346 size
= ldb
->vm
.vblk_size
;
1347 perbuf
= 512 / size
;
1348 skip
= ldb
->vm
.vblk_offset
>> 9; /* Bytes to sectors */
1349 finish
= (size
* ldb
->vm
.last_vblk_seq
) >> 9;
1351 for (s
= skip
; s
< finish
; s
++) { /* For each sector */
1352 data
= read_dev_sector (bdev
, base
+ OFF_VMDB
+ s
, §
);
1354 ldm_crit ("Disk read failed.");
1358 for (v
= 0; v
< perbuf
; v
++, data
+=size
) { /* For each vblk */
1359 if (MAGIC_VBLK
!= BE32 (data
)) {
1360 ldm_error ("Expected to find a VBLK.");
1364 recs
= BE16 (data
+ 0x0E); /* Number of records */
1366 if (!ldm_ldmdb_add (data
, size
, ldb
))
1367 goto out
; /* Already logged */
1368 } else if (recs
> 1) {
1369 if (!ldm_frag_add (data
, size
, &frags
))
1370 goto out
; /* Already logged */
1372 /* else Record is not in use, ignore it. */
1374 put_dev_sector (sect
);
1378 result
= ldm_frag_commit (&frags
, ldb
); /* Failures, already logged */
1381 put_dev_sector (sect
);
1382 ldm_frag_free (&frags
);
1388 * ldm_free_vblks - Free a linked list of vblk's
1389 * @lh: Head of a linked list of struct vblk
1391 * Free a list of vblk's and free the memory used to maintain the list.
1395 static void ldm_free_vblks (struct list_head
*lh
)
1397 struct list_head
*item
, *tmp
;
1401 list_for_each_safe (item
, tmp
, lh
)
1402 kfree (list_entry (item
, struct vblk
, list
));
1407 * ldm_partition - Find out whether a device is a dynamic disk and handle it
1408 * @pp: List of the partitions parsed so far
1409 * @bdev: Device holding the LDM Database
1411 * This determines whether the device @bdev is a dynamic disk and if so creates
1412 * the partitions necessary in the gendisk structure pointed to by @hd.
1414 * We create a dummy device 1, which contains the LDM database, and then create
1415 * each partition described by the LDM database in sequence as devices 2+. For
1416 * example, if the device is hda, we would have: hda1: LDM database, hda2, hda3,
1417 * and so on: the actual data containing partitions.
1419 * Return: 1 Success, @bdev is a dynamic disk and we handled it
1420 * 0 Success, @bdev is not a dynamic disk
1421 * -1 An error occurred before enough information had been read
1422 * Or @bdev is a dynamic disk, but it may be corrupted
1424 int ldm_partition (struct parsed_partitions
*pp
, struct block_device
*bdev
)
1430 BUG_ON (!pp
|| !bdev
);
1432 /* Look for signs of a Dynamic Disk */
1433 if (!ldm_validate_partition_table (bdev
))
1436 ldb
= kmalloc (sizeof (*ldb
), GFP_KERNEL
);
1438 ldm_crit ("Out of memory.");
1442 /* Parse and check privheads. */
1443 if (!ldm_validate_privheads (bdev
, &ldb
->ph
))
1444 goto out
; /* Already logged */
1446 /* All further references are relative to base (database start). */
1447 base
= ldb
->ph
.config_start
;
1449 /* Parse and check tocs and vmdb. */
1450 if (!ldm_validate_tocblocks (bdev
, base
, ldb
) ||
1451 !ldm_validate_vmdb (bdev
, base
, ldb
))
1452 goto out
; /* Already logged */
1454 /* Initialize vblk lists in ldmdb struct */
1455 INIT_LIST_HEAD (&ldb
->v_dgrp
);
1456 INIT_LIST_HEAD (&ldb
->v_disk
);
1457 INIT_LIST_HEAD (&ldb
->v_volu
);
1458 INIT_LIST_HEAD (&ldb
->v_comp
);
1459 INIT_LIST_HEAD (&ldb
->v_part
);
1461 if (!ldm_get_vblks (bdev
, base
, ldb
)) {
1462 ldm_crit ("Failed to read the VBLKs from the database.");
1466 /* Finally, create the data partition devices. */
1467 if (ldm_create_data_partitions (pp
, ldb
)) {
1468 ldm_debug ("Parsed LDM database successfully.");
1471 /* else Already logged */
1474 ldm_free_vblks (&ldb
->v_dgrp
);
1475 ldm_free_vblks (&ldb
->v_disk
);
1476 ldm_free_vblks (&ldb
->v_volu
);
1477 ldm_free_vblks (&ldb
->v_comp
);
1478 ldm_free_vblks (&ldb
->v_part
);