initial commit with v2.6.32.60
[linux-2.6.32.60-moxart.git] / fs / partitions / efi.c
blob6ab70f413a57d8d8c345a3c2c4702d553241ca0c
1 /************************************************************
2 * EFI GUID Partition Table handling
4 * http://www.uefi.org/specs/
5 * http://www.intel.com/technology/efi/
7 * efi.[ch] by Matt Domsch <Matt_Domsch@dell.com>
8 * Copyright 2000,2001,2002,2004 Dell Inc.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 * TODO:
27 * Changelog:
28 * Mon Nov 09 2004 Matt Domsch <Matt_Domsch@dell.com>
29 * - test for valid PMBR and valid PGPT before ever reading
30 * AGPT, allow override with 'gpt' kernel command line option.
31 * - check for first/last_usable_lba outside of size of disk
33 * Tue Mar 26 2002 Matt Domsch <Matt_Domsch@dell.com>
34 * - Ported to 2.5.7-pre1 and 2.5.7-dj2
35 * - Applied patch to avoid fault in alternate header handling
36 * - cleaned up find_valid_gpt
37 * - On-disk structure and copy in memory is *always* LE now -
38 * swab fields as needed
39 * - remove print_gpt_header()
40 * - only use first max_p partition entries, to keep the kernel minor number
41 * and partition numbers tied.
43 * Mon Feb 04 2002 Matt Domsch <Matt_Domsch@dell.com>
44 * - Removed __PRIPTR_PREFIX - not being used
46 * Mon Jan 14 2002 Matt Domsch <Matt_Domsch@dell.com>
47 * - Ported to 2.5.2-pre11 + library crc32 patch Linus applied
49 * Thu Dec 6 2001 Matt Domsch <Matt_Domsch@dell.com>
50 * - Added compare_gpts().
51 * - moved le_efi_guid_to_cpus() back into this file. GPT is the only
52 * thing that keeps EFI GUIDs on disk.
53 * - Changed gpt structure names and members to be simpler and more Linux-like.
55 * Wed Oct 17 2001 Matt Domsch <Matt_Domsch@dell.com>
56 * - Removed CONFIG_DEVFS_VOLUMES_UUID code entirely per Martin Wilck
58 * Wed Oct 10 2001 Matt Domsch <Matt_Domsch@dell.com>
59 * - Changed function comments to DocBook style per Andreas Dilger suggestion.
61 * Mon Oct 08 2001 Matt Domsch <Matt_Domsch@dell.com>
62 * - Change read_lba() to use the page cache per Al Viro's work.
63 * - print u64s properly on all architectures
64 * - fixed debug_printk(), now Dprintk()
66 * Mon Oct 01 2001 Matt Domsch <Matt_Domsch@dell.com>
67 * - Style cleanups
68 * - made most functions static
69 * - Endianness addition
70 * - remove test for second alternate header, as it's not per spec,
71 * and is unnecessary. There's now a method to read/write the last
72 * sector of an odd-sized disk from user space. No tools have ever
73 * been released which used this code, so it's effectively dead.
74 * - Per Asit Mallick of Intel, added a test for a valid PMBR.
75 * - Added kernel command line option 'gpt' to override valid PMBR test.
77 * Wed Jun 6 2001 Martin Wilck <Martin.Wilck@Fujitsu-Siemens.com>
78 * - added devfs volume UUID support (/dev/volumes/uuids) for
79 * mounting file systems by the partition GUID.
81 * Tue Dec 5 2000 Matt Domsch <Matt_Domsch@dell.com>
82 * - Moved crc32() to linux/lib, added efi_crc32().
84 * Thu Nov 30 2000 Matt Domsch <Matt_Domsch@dell.com>
85 * - Replaced Intel's CRC32 function with an equivalent
86 * non-license-restricted version.
88 * Wed Oct 25 2000 Matt Domsch <Matt_Domsch@dell.com>
89 * - Fixed the last_lba() call to return the proper last block
91 * Thu Oct 12 2000 Matt Domsch <Matt_Domsch@dell.com>
92 * - Thanks to Andries Brouwer for his debugging assistance.
93 * - Code works, detects all the partitions.
95 ************************************************************/
96 #include <linux/crc32.h>
97 #include <linux/math64.h>
98 #include "check.h"
99 #include "efi.h"
101 /* This allows a kernel command line option 'gpt' to override
102 * the test for invalid PMBR. Not __initdata because reloading
103 * the partition tables happens after init too.
105 static int force_gpt;
106 static int __init
107 force_gpt_fn(char *str)
109 force_gpt = 1;
110 return 1;
112 __setup("gpt", force_gpt_fn);
116 * efi_crc32() - EFI version of crc32 function
117 * @buf: buffer to calculate crc32 of
118 * @len - length of buf
120 * Description: Returns EFI-style CRC32 value for @buf
122 * This function uses the little endian Ethernet polynomial
123 * but seeds the function with ~0, and xor's with ~0 at the end.
124 * Note, the EFI Specification, v1.02, has a reference to
125 * Dr. Dobbs Journal, May 1994 (actually it's in May 1992).
127 static inline u32
128 efi_crc32(const void *buf, unsigned long len)
130 return (crc32(~0L, buf, len) ^ ~0L);
134 * last_lba(): return number of last logical block of device
135 * @bdev: block device
137 * Description: Returns last LBA value on success, 0 on error.
138 * This is stored (by sd and ide-geometry) in
139 * the part[0] entry for this disk, and is the number of
140 * physical sectors available on the disk.
142 static u64
143 last_lba(struct block_device *bdev)
145 if (!bdev || !bdev->bd_inode)
146 return 0;
147 return div_u64(bdev->bd_inode->i_size,
148 bdev_logical_block_size(bdev)) - 1ULL;
151 static inline int
152 pmbr_part_valid(struct partition *part)
154 if (part->sys_ind == EFI_PMBR_OSTYPE_EFI_GPT &&
155 le32_to_cpu(part->start_sect) == 1UL)
156 return 1;
157 return 0;
161 * is_pmbr_valid(): test Protective MBR for validity
162 * @mbr: pointer to a legacy mbr structure
164 * Description: Returns 1 if PMBR is valid, 0 otherwise.
165 * Validity depends on two things:
166 * 1) MSDOS signature is in the last two bytes of the MBR
167 * 2) One partition of type 0xEE is found
169 static int
170 is_pmbr_valid(legacy_mbr *mbr)
172 int i;
173 if (!mbr || le16_to_cpu(mbr->signature) != MSDOS_MBR_SIGNATURE)
174 return 0;
175 for (i = 0; i < 4; i++)
176 if (pmbr_part_valid(&mbr->partition_record[i]))
177 return 1;
178 return 0;
182 * read_lba(): Read bytes from disk, starting at given LBA
183 * @bdev
184 * @lba
185 * @buffer
186 * @size_t
188 * Description: Reads @count bytes from @bdev into @buffer.
189 * Returns number of bytes read on success, 0 on error.
191 static size_t
192 read_lba(struct block_device *bdev, u64 lba, u8 * buffer, size_t count)
194 size_t totalreadcount = 0;
195 sector_t n = lba * (bdev_logical_block_size(bdev) / 512);
197 if (!bdev || !buffer || lba > last_lba(bdev))
198 return 0;
200 while (count) {
201 int copied = 512;
202 Sector sect;
203 unsigned char *data = read_dev_sector(bdev, n++, &sect);
204 if (!data)
205 break;
206 if (copied > count)
207 copied = count;
208 memcpy(buffer, data, copied);
209 put_dev_sector(sect);
210 buffer += copied;
211 totalreadcount +=copied;
212 count -= copied;
214 return totalreadcount;
218 * alloc_read_gpt_entries(): reads partition entries from disk
219 * @bdev
220 * @gpt - GPT header
222 * Description: Returns ptes on success, NULL on error.
223 * Allocates space for PTEs based on information found in @gpt.
224 * Notes: remember to free pte when you're done!
226 static gpt_entry *
227 alloc_read_gpt_entries(struct block_device *bdev, gpt_header *gpt)
229 size_t count;
230 gpt_entry *pte;
231 if (!bdev || !gpt)
232 return NULL;
234 count = le32_to_cpu(gpt->num_partition_entries) *
235 le32_to_cpu(gpt->sizeof_partition_entry);
236 if (!count)
237 return NULL;
238 pte = kzalloc(count, GFP_KERNEL);
239 if (!pte)
240 return NULL;
242 if (read_lba(bdev, le64_to_cpu(gpt->partition_entry_lba),
243 (u8 *) pte,
244 count) < count) {
245 kfree(pte);
246 pte=NULL;
247 return NULL;
249 return pte;
253 * alloc_read_gpt_header(): Allocates GPT header, reads into it from disk
254 * @bdev
255 * @lba is the Logical Block Address of the partition table
257 * Description: returns GPT header on success, NULL on error. Allocates
258 * and fills a GPT header starting at @ from @bdev.
259 * Note: remember to free gpt when finished with it.
261 static gpt_header *
262 alloc_read_gpt_header(struct block_device *bdev, u64 lba)
264 gpt_header *gpt;
265 unsigned ssz = bdev_logical_block_size(bdev);
267 if (!bdev)
268 return NULL;
270 gpt = kzalloc(ssz, GFP_KERNEL);
271 if (!gpt)
272 return NULL;
274 if (read_lba(bdev, lba, (u8 *) gpt, ssz) < ssz) {
275 kfree(gpt);
276 gpt=NULL;
277 return NULL;
280 return gpt;
284 * is_gpt_valid() - tests one GPT header and PTEs for validity
285 * @bdev
286 * @lba is the logical block address of the GPT header to test
287 * @gpt is a GPT header ptr, filled on return.
288 * @ptes is a PTEs ptr, filled on return.
290 * Description: returns 1 if valid, 0 on error.
291 * If valid, returns pointers to newly allocated GPT header and PTEs.
293 static int
294 is_gpt_valid(struct block_device *bdev, u64 lba,
295 gpt_header **gpt, gpt_entry **ptes)
297 u32 crc, origcrc;
298 u64 lastlba;
300 if (!bdev || !gpt || !ptes)
301 return 0;
302 if (!(*gpt = alloc_read_gpt_header(bdev, lba)))
303 return 0;
305 /* Check the GUID Partition Table signature */
306 if (le64_to_cpu((*gpt)->signature) != GPT_HEADER_SIGNATURE) {
307 pr_debug("GUID Partition Table Header signature is wrong:"
308 "%lld != %lld\n",
309 (unsigned long long)le64_to_cpu((*gpt)->signature),
310 (unsigned long long)GPT_HEADER_SIGNATURE);
311 goto fail;
314 /* Check the GUID Partition Table header size */
315 if (le32_to_cpu((*gpt)->header_size) >
316 bdev_logical_block_size(bdev)) {
317 pr_debug("GUID Partition Table Header size is wrong: %u > %u\n",
318 le32_to_cpu((*gpt)->header_size),
319 bdev_logical_block_size(bdev));
320 goto fail;
323 /* Check the GUID Partition Table CRC */
324 origcrc = le32_to_cpu((*gpt)->header_crc32);
325 (*gpt)->header_crc32 = 0;
326 crc = efi_crc32((const unsigned char *) (*gpt), le32_to_cpu((*gpt)->header_size));
328 if (crc != origcrc) {
329 pr_debug("GUID Partition Table Header CRC is wrong: %x != %x\n",
330 crc, origcrc);
331 goto fail;
333 (*gpt)->header_crc32 = cpu_to_le32(origcrc);
335 /* Check that the my_lba entry points to the LBA that contains
336 * the GUID Partition Table */
337 if (le64_to_cpu((*gpt)->my_lba) != lba) {
338 pr_debug("GPT my_lba incorrect: %lld != %lld\n",
339 (unsigned long long)le64_to_cpu((*gpt)->my_lba),
340 (unsigned long long)lba);
341 goto fail;
344 /* Check the first_usable_lba and last_usable_lba are
345 * within the disk.
347 lastlba = last_lba(bdev);
348 if (le64_to_cpu((*gpt)->first_usable_lba) > lastlba) {
349 pr_debug("GPT: first_usable_lba incorrect: %lld > %lld\n",
350 (unsigned long long)le64_to_cpu((*gpt)->first_usable_lba),
351 (unsigned long long)lastlba);
352 goto fail;
354 if (le64_to_cpu((*gpt)->last_usable_lba) > lastlba) {
355 pr_debug("GPT: last_usable_lba incorrect: %lld > %lld\n",
356 (unsigned long long)le64_to_cpu((*gpt)->last_usable_lba),
357 (unsigned long long)lastlba);
358 goto fail;
361 /* Check that sizeof_partition_entry has the correct value */
362 if (le32_to_cpu((*gpt)->sizeof_partition_entry) != sizeof(gpt_entry)) {
363 pr_debug("GUID Partitition Entry Size check failed.\n");
364 goto fail;
367 if (!(*ptes = alloc_read_gpt_entries(bdev, *gpt)))
368 goto fail;
370 /* Check the GUID Partition Entry Array CRC */
371 crc = efi_crc32((const unsigned char *) (*ptes),
372 le32_to_cpu((*gpt)->num_partition_entries) *
373 le32_to_cpu((*gpt)->sizeof_partition_entry));
375 if (crc != le32_to_cpu((*gpt)->partition_entry_array_crc32)) {
376 pr_debug("GUID Partitition Entry Array CRC check failed.\n");
377 goto fail_ptes;
380 /* We're done, all's well */
381 return 1;
383 fail_ptes:
384 kfree(*ptes);
385 *ptes = NULL;
386 fail:
387 kfree(*gpt);
388 *gpt = NULL;
389 return 0;
393 * is_pte_valid() - tests one PTE for validity
394 * @pte is the pte to check
395 * @lastlba is last lba of the disk
397 * Description: returns 1 if valid, 0 on error.
399 static inline int
400 is_pte_valid(const gpt_entry *pte, const u64 lastlba)
402 if ((!efi_guidcmp(pte->partition_type_guid, NULL_GUID)) ||
403 le64_to_cpu(pte->starting_lba) > lastlba ||
404 le64_to_cpu(pte->ending_lba) > lastlba)
405 return 0;
406 return 1;
410 * compare_gpts() - Search disk for valid GPT headers and PTEs
411 * @pgpt is the primary GPT header
412 * @agpt is the alternate GPT header
413 * @lastlba is the last LBA number
414 * Description: Returns nothing. Sanity checks pgpt and agpt fields
415 * and prints warnings on discrepancies.
418 static void
419 compare_gpts(gpt_header *pgpt, gpt_header *agpt, u64 lastlba)
421 int error_found = 0;
422 if (!pgpt || !agpt)
423 return;
424 if (le64_to_cpu(pgpt->my_lba) != le64_to_cpu(agpt->alternate_lba)) {
425 printk(KERN_WARNING
426 "GPT:Primary header LBA != Alt. header alternate_lba\n");
427 printk(KERN_WARNING "GPT:%lld != %lld\n",
428 (unsigned long long)le64_to_cpu(pgpt->my_lba),
429 (unsigned long long)le64_to_cpu(agpt->alternate_lba));
430 error_found++;
432 if (le64_to_cpu(pgpt->alternate_lba) != le64_to_cpu(agpt->my_lba)) {
433 printk(KERN_WARNING
434 "GPT:Primary header alternate_lba != Alt. header my_lba\n");
435 printk(KERN_WARNING "GPT:%lld != %lld\n",
436 (unsigned long long)le64_to_cpu(pgpt->alternate_lba),
437 (unsigned long long)le64_to_cpu(agpt->my_lba));
438 error_found++;
440 if (le64_to_cpu(pgpt->first_usable_lba) !=
441 le64_to_cpu(agpt->first_usable_lba)) {
442 printk(KERN_WARNING "GPT:first_usable_lbas don't match.\n");
443 printk(KERN_WARNING "GPT:%lld != %lld\n",
444 (unsigned long long)le64_to_cpu(pgpt->first_usable_lba),
445 (unsigned long long)le64_to_cpu(agpt->first_usable_lba));
446 error_found++;
448 if (le64_to_cpu(pgpt->last_usable_lba) !=
449 le64_to_cpu(agpt->last_usable_lba)) {
450 printk(KERN_WARNING "GPT:last_usable_lbas don't match.\n");
451 printk(KERN_WARNING "GPT:%lld != %lld\n",
452 (unsigned long long)le64_to_cpu(pgpt->last_usable_lba),
453 (unsigned long long)le64_to_cpu(agpt->last_usable_lba));
454 error_found++;
456 if (efi_guidcmp(pgpt->disk_guid, agpt->disk_guid)) {
457 printk(KERN_WARNING "GPT:disk_guids don't match.\n");
458 error_found++;
460 if (le32_to_cpu(pgpt->num_partition_entries) !=
461 le32_to_cpu(agpt->num_partition_entries)) {
462 printk(KERN_WARNING "GPT:num_partition_entries don't match: "
463 "0x%x != 0x%x\n",
464 le32_to_cpu(pgpt->num_partition_entries),
465 le32_to_cpu(agpt->num_partition_entries));
466 error_found++;
468 if (le32_to_cpu(pgpt->sizeof_partition_entry) !=
469 le32_to_cpu(agpt->sizeof_partition_entry)) {
470 printk(KERN_WARNING
471 "GPT:sizeof_partition_entry values don't match: "
472 "0x%x != 0x%x\n",
473 le32_to_cpu(pgpt->sizeof_partition_entry),
474 le32_to_cpu(agpt->sizeof_partition_entry));
475 error_found++;
477 if (le32_to_cpu(pgpt->partition_entry_array_crc32) !=
478 le32_to_cpu(agpt->partition_entry_array_crc32)) {
479 printk(KERN_WARNING
480 "GPT:partition_entry_array_crc32 values don't match: "
481 "0x%x != 0x%x\n",
482 le32_to_cpu(pgpt->partition_entry_array_crc32),
483 le32_to_cpu(agpt->partition_entry_array_crc32));
484 error_found++;
486 if (le64_to_cpu(pgpt->alternate_lba) != lastlba) {
487 printk(KERN_WARNING
488 "GPT:Primary header thinks Alt. header is not at the end of the disk.\n");
489 printk(KERN_WARNING "GPT:%lld != %lld\n",
490 (unsigned long long)le64_to_cpu(pgpt->alternate_lba),
491 (unsigned long long)lastlba);
492 error_found++;
495 if (le64_to_cpu(agpt->my_lba) != lastlba) {
496 printk(KERN_WARNING
497 "GPT:Alternate GPT header not at the end of the disk.\n");
498 printk(KERN_WARNING "GPT:%lld != %lld\n",
499 (unsigned long long)le64_to_cpu(agpt->my_lba),
500 (unsigned long long)lastlba);
501 error_found++;
504 if (error_found)
505 printk(KERN_WARNING
506 "GPT: Use GNU Parted to correct GPT errors.\n");
507 return;
511 * find_valid_gpt() - Search disk for valid GPT headers and PTEs
512 * @bdev
513 * @gpt is a GPT header ptr, filled on return.
514 * @ptes is a PTEs ptr, filled on return.
515 * Description: Returns 1 if valid, 0 on error.
516 * If valid, returns pointers to newly allocated GPT header and PTEs.
517 * Validity depends on PMBR being valid (or being overridden by the
518 * 'gpt' kernel command line option) and finding either the Primary
519 * GPT header and PTEs valid, or the Alternate GPT header and PTEs
520 * valid. If the Primary GPT header is not valid, the Alternate GPT header
521 * is not checked unless the 'gpt' kernel command line option is passed.
522 * This protects against devices which misreport their size, and forces
523 * the user to decide to use the Alternate GPT.
525 static int
526 find_valid_gpt(struct block_device *bdev, gpt_header **gpt, gpt_entry **ptes)
528 int good_pgpt = 0, good_agpt = 0, good_pmbr = 0;
529 gpt_header *pgpt = NULL, *agpt = NULL;
530 gpt_entry *pptes = NULL, *aptes = NULL;
531 legacy_mbr *legacymbr;
532 u64 lastlba;
533 if (!bdev || !gpt || !ptes)
534 return 0;
536 lastlba = last_lba(bdev);
537 if (!force_gpt) {
538 /* This will be added to the EFI Spec. per Intel after v1.02. */
539 legacymbr = kzalloc(sizeof (*legacymbr), GFP_KERNEL);
540 if (legacymbr) {
541 read_lba(bdev, 0, (u8 *) legacymbr,
542 sizeof (*legacymbr));
543 good_pmbr = is_pmbr_valid(legacymbr);
544 kfree(legacymbr);
546 if (!good_pmbr)
547 goto fail;
550 good_pgpt = is_gpt_valid(bdev, GPT_PRIMARY_PARTITION_TABLE_LBA,
551 &pgpt, &pptes);
552 if (good_pgpt)
553 good_agpt = is_gpt_valid(bdev,
554 le64_to_cpu(pgpt->alternate_lba),
555 &agpt, &aptes);
556 if (!good_agpt && force_gpt)
557 good_agpt = is_gpt_valid(bdev, lastlba,
558 &agpt, &aptes);
560 /* The obviously unsuccessful case */
561 if (!good_pgpt && !good_agpt)
562 goto fail;
564 compare_gpts(pgpt, agpt, lastlba);
566 /* The good cases */
567 if (good_pgpt) {
568 *gpt = pgpt;
569 *ptes = pptes;
570 kfree(agpt);
571 kfree(aptes);
572 if (!good_agpt) {
573 printk(KERN_WARNING
574 "Alternate GPT is invalid, "
575 "using primary GPT.\n");
577 return 1;
579 else if (good_agpt) {
580 *gpt = agpt;
581 *ptes = aptes;
582 kfree(pgpt);
583 kfree(pptes);
584 printk(KERN_WARNING
585 "Primary GPT is invalid, using alternate GPT.\n");
586 return 1;
589 fail:
590 kfree(pgpt);
591 kfree(agpt);
592 kfree(pptes);
593 kfree(aptes);
594 *gpt = NULL;
595 *ptes = NULL;
596 return 0;
600 * efi_partition(struct parsed_partitions *state, struct block_device *bdev)
601 * @state
602 * @bdev
604 * Description: called from check.c, if the disk contains GPT
605 * partitions, sets up partition entries in the kernel.
607 * If the first block on the disk is a legacy MBR,
608 * it will get handled by msdos_partition().
609 * If it's a Protective MBR, we'll handle it here.
611 * We do not create a Linux partition for GPT, but
612 * only for the actual data partitions.
613 * Returns:
614 * -1 if unable to read the partition table
615 * 0 if this isn't our partition table
616 * 1 if successful
620 efi_partition(struct parsed_partitions *state, struct block_device *bdev)
622 gpt_header *gpt = NULL;
623 gpt_entry *ptes = NULL;
624 u32 i;
625 unsigned ssz = bdev_logical_block_size(bdev) / 512;
627 if (!find_valid_gpt(bdev, &gpt, &ptes) || !gpt || !ptes) {
628 kfree(gpt);
629 kfree(ptes);
630 return 0;
633 pr_debug("GUID Partition Table is valid! Yea!\n");
635 for (i = 0; i < le32_to_cpu(gpt->num_partition_entries) && i < state->limit-1; i++) {
636 u64 start = le64_to_cpu(ptes[i].starting_lba);
637 u64 size = le64_to_cpu(ptes[i].ending_lba) -
638 le64_to_cpu(ptes[i].starting_lba) + 1ULL;
640 if (!is_pte_valid(&ptes[i], last_lba(bdev)))
641 continue;
643 put_partition(state, i+1, start * ssz, size * ssz);
645 /* If this is a RAID volume, tell md */
646 if (!efi_guidcmp(ptes[i].partition_type_guid,
647 PARTITION_LINUX_RAID_GUID))
648 state->parts[i+1].flags = 1;
650 kfree(ptes);
651 kfree(gpt);
652 printk("\n");
653 return 1;