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
28 * Mon August 5th, 2013 Davidlohr Bueso <davidlohr@hp.com>
29 * - detect hybrid MBRs, tighter pMBR checking & cleanups.
31 * Mon Nov 09 2004 Matt Domsch <Matt_Domsch@dell.com>
32 * - test for valid PMBR and valid PGPT before ever reading
33 * AGPT, allow override with 'gpt' kernel command line option.
34 * - check for first/last_usable_lba outside of size of disk
36 * Tue Mar 26 2002 Matt Domsch <Matt_Domsch@dell.com>
37 * - Ported to 2.5.7-pre1 and 2.5.7-dj2
38 * - Applied patch to avoid fault in alternate header handling
39 * - cleaned up find_valid_gpt
40 * - On-disk structure and copy in memory is *always* LE now -
41 * swab fields as needed
42 * - remove print_gpt_header()
43 * - only use first max_p partition entries, to keep the kernel minor number
44 * and partition numbers tied.
46 * Mon Feb 04 2002 Matt Domsch <Matt_Domsch@dell.com>
47 * - Removed __PRIPTR_PREFIX - not being used
49 * Mon Jan 14 2002 Matt Domsch <Matt_Domsch@dell.com>
50 * - Ported to 2.5.2-pre11 + library crc32 patch Linus applied
52 * Thu Dec 6 2001 Matt Domsch <Matt_Domsch@dell.com>
53 * - Added compare_gpts().
54 * - moved le_efi_guid_to_cpus() back into this file. GPT is the only
55 * thing that keeps EFI GUIDs on disk.
56 * - Changed gpt structure names and members to be simpler and more Linux-like.
58 * Wed Oct 17 2001 Matt Domsch <Matt_Domsch@dell.com>
59 * - Removed CONFIG_DEVFS_VOLUMES_UUID code entirely per Martin Wilck
61 * Wed Oct 10 2001 Matt Domsch <Matt_Domsch@dell.com>
62 * - Changed function comments to DocBook style per Andreas Dilger suggestion.
64 * Mon Oct 08 2001 Matt Domsch <Matt_Domsch@dell.com>
65 * - Change read_lba() to use the page cache per Al Viro's work.
66 * - print u64s properly on all architectures
67 * - fixed debug_printk(), now Dprintk()
69 * Mon Oct 01 2001 Matt Domsch <Matt_Domsch@dell.com>
71 * - made most functions static
72 * - Endianness addition
73 * - remove test for second alternate header, as it's not per spec,
74 * and is unnecessary. There's now a method to read/write the last
75 * sector of an odd-sized disk from user space. No tools have ever
76 * been released which used this code, so it's effectively dead.
77 * - Per Asit Mallick of Intel, added a test for a valid PMBR.
78 * - Added kernel command line option 'gpt' to override valid PMBR test.
80 * Wed Jun 6 2001 Martin Wilck <Martin.Wilck@Fujitsu-Siemens.com>
81 * - added devfs volume UUID support (/dev/volumes/uuids) for
82 * mounting file systems by the partition GUID.
84 * Tue Dec 5 2000 Matt Domsch <Matt_Domsch@dell.com>
85 * - Moved crc32() to linux/lib, added efi_crc32().
87 * Thu Nov 30 2000 Matt Domsch <Matt_Domsch@dell.com>
88 * - Replaced Intel's CRC32 function with an equivalent
89 * non-license-restricted version.
91 * Wed Oct 25 2000 Matt Domsch <Matt_Domsch@dell.com>
92 * - Fixed the last_lba() call to return the proper last block
94 * Thu Oct 12 2000 Matt Domsch <Matt_Domsch@dell.com>
95 * - Thanks to Andries Brouwer for his debugging assistance.
96 * - Code works, detects all the partitions.
98 ************************************************************/
99 #include <linux/kernel.h>
100 #include <linux/crc32.h>
101 #include <linux/ctype.h>
102 #include <linux/math64.h>
103 #include <linux/slab.h>
107 /* This allows a kernel command line option 'gpt' to override
108 * the test for invalid PMBR. Not __initdata because reloading
109 * the partition tables happens after init too.
111 static int force_gpt;
113 force_gpt_fn(char *str)
118 __setup("gpt", force_gpt_fn);
122 * efi_crc32() - EFI version of crc32 function
123 * @buf: buffer to calculate crc32 of
124 * @len - length of buf
126 * Description: Returns EFI-style CRC32 value for @buf
128 * This function uses the little endian Ethernet polynomial
129 * but seeds the function with ~0, and xor's with ~0 at the end.
130 * Note, the EFI Specification, v1.02, has a reference to
131 * Dr. Dobbs Journal, May 1994 (actually it's in May 1992).
134 efi_crc32(const void *buf, unsigned long len)
136 return (crc32(~0L, buf, len) ^ ~0L);
140 * last_lba(): return number of last logical block of device
141 * @bdev: block device
143 * Description: Returns last LBA value on success, 0 on error.
144 * This is stored (by sd and ide-geometry) in
145 * the part[0] entry for this disk, and is the number of
146 * physical sectors available on the disk.
148 static u64 last_lba(struct block_device *bdev)
150 if (!bdev || !bdev->bd_inode)
152 return div_u64(bdev->bd_inode->i_size,
153 bdev_logical_block_size(bdev)) - 1ULL;
156 static inline int pmbr_part_valid(gpt_mbr_record *part)
158 if (part->os_type != EFI_PMBR_OSTYPE_EFI_GPT)
161 /* set to 0x00000001 (i.e., the LBA of the GPT Partition Header) */
162 if (le32_to_cpu(part->starting_lba) != GPT_PRIMARY_PARTITION_TABLE_LBA)
165 return GPT_MBR_PROTECTIVE;
171 * is_pmbr_valid(): test Protective MBR for validity
172 * @mbr: pointer to a legacy mbr structure
173 * @total_sectors: amount of sectors in the device
175 * Description: Checks for a valid protective or hybrid
176 * master boot record (MBR). The validity of a pMBR depends
177 * on all of the following properties:
178 * 1) MSDOS signature is in the last two bytes of the MBR
179 * 2) One partition of type 0xEE is found
181 * In addition, a hybrid MBR will have up to three additional
182 * primary partitions, which point to the same space that's
183 * marked out by up to three GPT partitions.
185 * Returns 0 upon invalid MBR, or GPT_MBR_PROTECTIVE or
186 * GPT_MBR_HYBRID depending on the device layout.
188 static int is_pmbr_valid(legacy_mbr *mbr, sector_t total_sectors)
191 int i, part = 0, ret = 0; /* invalid by default */
193 if (!mbr || le16_to_cpu(mbr->signature) != MSDOS_MBR_SIGNATURE)
196 for (i = 0; i < 4; i++) {
197 ret = pmbr_part_valid(&mbr->partition_record[i]);
198 if (ret == GPT_MBR_PROTECTIVE) {
201 * Ok, we at least know that there's a protective MBR,
202 * now check if there are other partition types for
209 if (ret != GPT_MBR_PROTECTIVE)
212 for (i = 0; i < 4; i++)
213 if ((mbr->partition_record[i].os_type !=
214 EFI_PMBR_OSTYPE_EFI_GPT) &&
215 (mbr->partition_record[i].os_type != 0x00))
216 ret = GPT_MBR_HYBRID;
219 * Protective MBRs take up the lesser of the whole disk
220 * or 2 TiB (32bit LBA), ignoring the rest of the disk.
221 * Some partitioning programs, nonetheless, choose to set
222 * the size to the maximum 32-bit limitation, disregarding
225 * Hybrid MBRs do not necessarily comply with this.
227 * Consider a bad value here to be a warning to support dd'ing
228 * an image from a smaller disk to a larger disk.
230 if (ret == GPT_MBR_PROTECTIVE) {
231 sz = le32_to_cpu(mbr->partition_record[part].size_in_lba);
232 if (sz != (uint32_t) total_sectors - 1 && sz != 0xFFFFFFFF)
233 pr_debug("GPT: mbr size in lba (%u) different than whole disk (%u).\n",
235 total_sectors - 1, 0xFFFFFFFF));
242 * read_lba(): Read bytes from disk, starting at given LBA
248 * Description: Reads @count bytes from @state->bdev into @buffer.
249 * Returns number of bytes read on success, 0 on error.
251 static size_t read_lba(struct parsed_partitions *state,
252 u64 lba, u8 *buffer, size_t count)
254 size_t totalreadcount = 0;
255 struct block_device *bdev = state->bdev;
256 sector_t n = lba * (bdev_logical_block_size(bdev) / 512);
258 if (!buffer || lba > last_lba(bdev))
264 unsigned char *data = read_part_sector(state, n++, §);
269 memcpy(buffer, data, copied);
270 put_dev_sector(sect);
272 totalreadcount +=copied;
275 return totalreadcount;
279 * alloc_read_gpt_entries(): reads partition entries from disk
283 * Description: Returns ptes on success, NULL on error.
284 * Allocates space for PTEs based on information found in @gpt.
285 * Notes: remember to free pte when you're done!
287 static gpt_entry *alloc_read_gpt_entries(struct parsed_partitions *state,
296 count = le32_to_cpu(gpt->num_partition_entries) *
297 le32_to_cpu(gpt->sizeof_partition_entry);
300 pte = kmalloc(count, GFP_KERNEL);
304 if (read_lba(state, le64_to_cpu(gpt->partition_entry_lba),
305 (u8 *) pte, count) < count) {
314 * alloc_read_gpt_header(): Allocates GPT header, reads into it from disk
316 * @lba is the Logical Block Address of the partition table
318 * Description: returns GPT header on success, NULL on error. Allocates
319 * and fills a GPT header starting at @ from @state->bdev.
320 * Note: remember to free gpt when finished with it.
322 static gpt_header *alloc_read_gpt_header(struct parsed_partitions *state,
326 unsigned ssz = bdev_logical_block_size(state->bdev);
328 gpt = kmalloc(ssz, GFP_KERNEL);
332 if (read_lba(state, lba, (u8 *) gpt, ssz) < ssz) {
342 * is_gpt_valid() - tests one GPT header and PTEs for validity
344 * @lba is the logical block address of the GPT header to test
345 * @gpt is a GPT header ptr, filled on return.
346 * @ptes is a PTEs ptr, filled on return.
348 * Description: returns 1 if valid, 0 on error.
349 * If valid, returns pointers to newly allocated GPT header and PTEs.
351 static int is_gpt_valid(struct parsed_partitions *state, u64 lba,
352 gpt_header **gpt, gpt_entry **ptes)
359 if (!(*gpt = alloc_read_gpt_header(state, lba)))
362 /* Check the GUID Partition Table signature */
363 if (le64_to_cpu((*gpt)->signature) != GPT_HEADER_SIGNATURE) {
364 pr_debug("GUID Partition Table Header signature is wrong:"
366 (unsigned long long)le64_to_cpu((*gpt)->signature),
367 (unsigned long long)GPT_HEADER_SIGNATURE);
371 /* Check the GUID Partition Table header size is too big */
372 if (le32_to_cpu((*gpt)->header_size) >
373 bdev_logical_block_size(state->bdev)) {
374 pr_debug("GUID Partition Table Header size is too large: %u > %u\n",
375 le32_to_cpu((*gpt)->header_size),
376 bdev_logical_block_size(state->bdev));
380 /* Check the GUID Partition Table header size is too small */
381 if (le32_to_cpu((*gpt)->header_size) < sizeof(gpt_header)) {
382 pr_debug("GUID Partition Table Header size is too small: %u < %zu\n",
383 le32_to_cpu((*gpt)->header_size),
388 /* Check the GUID Partition Table CRC */
389 origcrc = le32_to_cpu((*gpt)->header_crc32);
390 (*gpt)->header_crc32 = 0;
391 crc = efi_crc32((const unsigned char *) (*gpt), le32_to_cpu((*gpt)->header_size));
393 if (crc != origcrc) {
394 pr_debug("GUID Partition Table Header CRC is wrong: %x != %x\n",
398 (*gpt)->header_crc32 = cpu_to_le32(origcrc);
400 /* Check that the my_lba entry points to the LBA that contains
401 * the GUID Partition Table */
402 if (le64_to_cpu((*gpt)->my_lba) != lba) {
403 pr_debug("GPT my_lba incorrect: %lld != %lld\n",
404 (unsigned long long)le64_to_cpu((*gpt)->my_lba),
405 (unsigned long long)lba);
409 /* Check the first_usable_lba and last_usable_lba are
412 lastlba = last_lba(state->bdev);
413 if (le64_to_cpu((*gpt)->first_usable_lba) > lastlba) {
414 pr_debug("GPT: first_usable_lba incorrect: %lld > %lld\n",
415 (unsigned long long)le64_to_cpu((*gpt)->first_usable_lba),
416 (unsigned long long)lastlba);
419 if (le64_to_cpu((*gpt)->last_usable_lba) > lastlba) {
420 pr_debug("GPT: last_usable_lba incorrect: %lld > %lld\n",
421 (unsigned long long)le64_to_cpu((*gpt)->last_usable_lba),
422 (unsigned long long)lastlba);
425 if (le64_to_cpu((*gpt)->last_usable_lba) < le64_to_cpu((*gpt)->first_usable_lba)) {
426 pr_debug("GPT: last_usable_lba incorrect: %lld > %lld\n",
427 (unsigned long long)le64_to_cpu((*gpt)->last_usable_lba),
428 (unsigned long long)le64_to_cpu((*gpt)->first_usable_lba));
431 /* Check that sizeof_partition_entry has the correct value */
432 if (le32_to_cpu((*gpt)->sizeof_partition_entry) != sizeof(gpt_entry)) {
433 pr_debug("GUID Partitition Entry Size check failed.\n");
437 if (!(*ptes = alloc_read_gpt_entries(state, *gpt)))
440 /* Check the GUID Partition Entry Array CRC */
441 crc = efi_crc32((const unsigned char *) (*ptes),
442 le32_to_cpu((*gpt)->num_partition_entries) *
443 le32_to_cpu((*gpt)->sizeof_partition_entry));
445 if (crc != le32_to_cpu((*gpt)->partition_entry_array_crc32)) {
446 pr_debug("GUID Partitition Entry Array CRC check failed.\n");
450 /* We're done, all's well */
463 * is_pte_valid() - tests one PTE for validity
464 * @pte is the pte to check
465 * @lastlba is last lba of the disk
467 * Description: returns 1 if valid, 0 on error.
470 is_pte_valid(const gpt_entry *pte, const u64 lastlba)
472 if ((!efi_guidcmp(pte->partition_type_guid, NULL_GUID)) ||
473 le64_to_cpu(pte->starting_lba) > lastlba ||
474 le64_to_cpu(pte->ending_lba) > lastlba)
480 * compare_gpts() - Search disk for valid GPT headers and PTEs
481 * @pgpt is the primary GPT header
482 * @agpt is the alternate GPT header
483 * @lastlba is the last LBA number
484 * Description: Returns nothing. Sanity checks pgpt and agpt fields
485 * and prints warnings on discrepancies.
489 compare_gpts(gpt_header *pgpt, gpt_header *agpt, u64 lastlba)
494 if (le64_to_cpu(pgpt->my_lba) != le64_to_cpu(agpt->alternate_lba)) {
495 pr_warn("GPT:Primary header LBA != Alt. header alternate_lba\n");
496 pr_warn("GPT:%lld != %lld\n",
497 (unsigned long long)le64_to_cpu(pgpt->my_lba),
498 (unsigned long long)le64_to_cpu(agpt->alternate_lba));
501 if (le64_to_cpu(pgpt->alternate_lba) != le64_to_cpu(agpt->my_lba)) {
502 pr_warn("GPT:Primary header alternate_lba != Alt. header my_lba\n");
503 pr_warn("GPT:%lld != %lld\n",
504 (unsigned long long)le64_to_cpu(pgpt->alternate_lba),
505 (unsigned long long)le64_to_cpu(agpt->my_lba));
508 if (le64_to_cpu(pgpt->first_usable_lba) !=
509 le64_to_cpu(agpt->first_usable_lba)) {
510 pr_warn("GPT:first_usable_lbas don't match.\n");
511 pr_warn("GPT:%lld != %lld\n",
512 (unsigned long long)le64_to_cpu(pgpt->first_usable_lba),
513 (unsigned long long)le64_to_cpu(agpt->first_usable_lba));
516 if (le64_to_cpu(pgpt->last_usable_lba) !=
517 le64_to_cpu(agpt->last_usable_lba)) {
518 pr_warn("GPT:last_usable_lbas don't match.\n");
519 pr_warn("GPT:%lld != %lld\n",
520 (unsigned long long)le64_to_cpu(pgpt->last_usable_lba),
521 (unsigned long long)le64_to_cpu(agpt->last_usable_lba));
524 if (efi_guidcmp(pgpt->disk_guid, agpt->disk_guid)) {
525 pr_warn("GPT:disk_guids don't match.\n");
528 if (le32_to_cpu(pgpt->num_partition_entries) !=
529 le32_to_cpu(agpt->num_partition_entries)) {
530 pr_warn("GPT:num_partition_entries don't match: "
532 le32_to_cpu(pgpt->num_partition_entries),
533 le32_to_cpu(agpt->num_partition_entries));
536 if (le32_to_cpu(pgpt->sizeof_partition_entry) !=
537 le32_to_cpu(agpt->sizeof_partition_entry)) {
538 pr_warn("GPT:sizeof_partition_entry values don't match: "
540 le32_to_cpu(pgpt->sizeof_partition_entry),
541 le32_to_cpu(agpt->sizeof_partition_entry));
544 if (le32_to_cpu(pgpt->partition_entry_array_crc32) !=
545 le32_to_cpu(agpt->partition_entry_array_crc32)) {
546 pr_warn("GPT:partition_entry_array_crc32 values don't match: "
548 le32_to_cpu(pgpt->partition_entry_array_crc32),
549 le32_to_cpu(agpt->partition_entry_array_crc32));
552 if (le64_to_cpu(pgpt->alternate_lba) != lastlba) {
553 pr_warn("GPT:Primary header thinks Alt. header is not at the end of the disk.\n");
554 pr_warn("GPT:%lld != %lld\n",
555 (unsigned long long)le64_to_cpu(pgpt->alternate_lba),
556 (unsigned long long)lastlba);
560 if (le64_to_cpu(agpt->my_lba) != lastlba) {
561 pr_warn("GPT:Alternate GPT header not at the end of the disk.\n");
562 pr_warn("GPT:%lld != %lld\n",
563 (unsigned long long)le64_to_cpu(agpt->my_lba),
564 (unsigned long long)lastlba);
569 pr_warn("GPT: Use GNU Parted to correct GPT errors.\n");
574 * find_valid_gpt() - Search disk for valid GPT headers and PTEs
576 * @gpt is a GPT header ptr, filled on return.
577 * @ptes is a PTEs ptr, filled on return.
578 * Description: Returns 1 if valid, 0 on error.
579 * If valid, returns pointers to newly allocated GPT header and PTEs.
580 * Validity depends on PMBR being valid (or being overridden by the
581 * 'gpt' kernel command line option) and finding either the Primary
582 * GPT header and PTEs valid, or the Alternate GPT header and PTEs
583 * valid. If the Primary GPT header is not valid, the Alternate GPT header
584 * is not checked unless the 'gpt' kernel command line option is passed.
585 * This protects against devices which misreport their size, and forces
586 * the user to decide to use the Alternate GPT.
588 static int find_valid_gpt(struct parsed_partitions *state, gpt_header **gpt,
591 int good_pgpt = 0, good_agpt = 0, good_pmbr = 0;
592 gpt_header *pgpt = NULL, *agpt = NULL;
593 gpt_entry *pptes = NULL, *aptes = NULL;
594 legacy_mbr *legacymbr;
595 sector_t total_sectors = i_size_read(state->bdev->bd_inode) >> 9;
601 lastlba = last_lba(state->bdev);
603 /* This will be added to the EFI Spec. per Intel after v1.02. */
604 legacymbr = kzalloc(sizeof(*legacymbr), GFP_KERNEL);
608 read_lba(state, 0, (u8 *)legacymbr, sizeof(*legacymbr));
609 good_pmbr = is_pmbr_valid(legacymbr, total_sectors);
615 pr_debug("Device has a %s MBR\n",
616 good_pmbr == GPT_MBR_PROTECTIVE ?
617 "protective" : "hybrid");
620 good_pgpt = is_gpt_valid(state, GPT_PRIMARY_PARTITION_TABLE_LBA,
623 good_agpt = is_gpt_valid(state,
624 le64_to_cpu(pgpt->alternate_lba),
626 if (!good_agpt && force_gpt)
627 good_agpt = is_gpt_valid(state, lastlba, &agpt, &aptes);
629 /* The obviously unsuccessful case */
630 if (!good_pgpt && !good_agpt)
633 compare_gpts(pgpt, agpt, lastlba);
642 pr_warn("Alternate GPT is invalid, using primary GPT.\n");
645 else if (good_agpt) {
650 pr_warn("Primary GPT is invalid, using alternate GPT.\n");
665 * efi_partition(struct parsed_partitions *state)
668 * Description: called from check.c, if the disk contains GPT
669 * partitions, sets up partition entries in the kernel.
671 * If the first block on the disk is a legacy MBR,
672 * it will get handled by msdos_partition().
673 * If it's a Protective MBR, we'll handle it here.
675 * We do not create a Linux partition for GPT, but
676 * only for the actual data partitions.
678 * -1 if unable to read the partition table
679 * 0 if this isn't our partition table
683 int efi_partition(struct parsed_partitions *state)
685 gpt_header *gpt = NULL;
686 gpt_entry *ptes = NULL;
688 unsigned ssz = bdev_logical_block_size(state->bdev) / 512;
690 if (!find_valid_gpt(state, &gpt, &ptes) || !gpt || !ptes) {
696 pr_debug("GUID Partition Table is valid! Yea!\n");
698 for (i = 0; i < le32_to_cpu(gpt->num_partition_entries) && i < state->limit-1; i++) {
699 struct partition_meta_info *info;
700 unsigned label_count = 0;
702 u64 start = le64_to_cpu(ptes[i].starting_lba);
703 u64 size = le64_to_cpu(ptes[i].ending_lba) -
704 le64_to_cpu(ptes[i].starting_lba) + 1ULL;
706 if (!is_pte_valid(&ptes[i], last_lba(state->bdev)))
709 put_partition(state, i+1, start * ssz, size * ssz);
711 /* If this is a RAID volume, tell md */
712 if (!efi_guidcmp(ptes[i].partition_type_guid, PARTITION_LINUX_RAID_GUID))
713 state->parts[i + 1].flags = ADDPART_FLAG_RAID;
715 info = &state->parts[i + 1].info;
716 efi_guid_unparse(&ptes[i].unique_partition_guid, info->uuid);
718 /* Naively convert UTF16-LE to 7 bits. */
719 label_max = min(ARRAY_SIZE(info->volname) - 1,
720 ARRAY_SIZE(ptes[i].partition_name));
721 info->volname[label_max] = 0;
722 while (label_count < label_max) {
723 u8 c = ptes[i].partition_name[label_count] & 0xff;
724 if (c && !isprint(c))
726 info->volname[label_count] = c;
729 state->parts[i + 1].has_info = true;
733 strlcat(state->pp_buf, "\n", PAGE_SIZE);