c78952
From 145214ee7c411c7d600016f011dc11b213bce0b2 Mon Sep 17 00:00:00 2001
9d15b4
From: Peter Jones <pjones@redhat.com>
9d15b4
Date: Thu, 9 Jun 2016 12:22:29 -0400
31cddd
Subject: [PATCH] Re-work some intricacies of PE loading.
9d15b4
9d15b4
The PE spec is not a well written document, and awesomely every place
9d15b4
where there's an ambiguous way to read something, Windows' bootmgfw.efi
9d15b4
takes a different read than either of them.
9d15b4
---
6f1e3d
 grub-core/loader/efi/chainloader.c | 156 +++++++++++++++++++++++++++++--------
9d15b4
 include/grub/efi/pe32.h            |  32 +++++++-
6f1e3d
 2 files changed, 152 insertions(+), 36 deletions(-)
9d15b4
9d15b4
diff --git a/grub-core/loader/efi/chainloader.c b/grub-core/loader/efi/chainloader.c
ec4acb
index aee8e6becf6..4b77a7d5adb 100644
9d15b4
--- a/grub-core/loader/efi/chainloader.c
9d15b4
+++ b/grub-core/loader/efi/chainloader.c
bc092b
@@ -301,7 +301,7 @@ image_is_64_bit (grub_pe_header_t *pe_hdr)
9d15b4
   return 0;
9d15b4
 }
9d15b4
 
9d15b4
-static const grub_uint16_t machine_type =
9d15b4
+static const grub_uint16_t machine_type __attribute__((__unused__)) =
9d15b4
 #if defined(__x86_64__)
9d15b4
   GRUB_PE32_MACHINE_X86_64;
9d15b4
 #elif defined(__aarch64__)
bc092b
@@ -367,10 +367,10 @@ relocate_coff (pe_coff_loader_image_context_t *context,
9d15b4
 
9d15b4
   reloc_base = image_address (orig, size, section->raw_data_offset);
9d15b4
   reloc_base_end = image_address (orig, size, section->raw_data_offset
9d15b4
-				  + section->virtual_size - 1);
9d15b4
+				  + section->virtual_size);
9d15b4
 
9d15b4
-  grub_dprintf ("chain", "reloc_base %p reloc_base_end %p\n", reloc_base,
9d15b4
-		reloc_base_end);
9d15b4
+  grub_dprintf ("chain", "relocate_coff(): reloc_base %p reloc_base_end %p\n",
9d15b4
+		reloc_base, reloc_base_end);
9d15b4
 
9d15b4
   if (!reloc_base && !reloc_base_end)
9d15b4
     return GRUB_EFI_SUCCESS;
6f1e3d
@@ -507,12 +507,13 @@ handle_image (void *data, grub_efi_uint32_t datasize)
9d15b4
   grub_efi_status_t efi_status;
6f1e3d
   char *buffer = NULL;
9d15b4
   char *buffer_aligned = NULL;
9d15b4
-  grub_efi_uint32_t i, size;
9d15b4
+  grub_efi_uint32_t i;
9d15b4
   struct grub_pe32_section_table *section;
9d15b4
   char *base, *end;
9d15b4
   pe_coff_loader_image_context_t context;
9d15b4
   grub_uint32_t section_alignment;
9d15b4
   grub_uint32_t buffer_size;
9d15b4
+  int found_entry_point = 0;
9d15b4
 
6f1e3d
   b = grub_efi_system_table->boot_services;
6f1e3d
 
6f1e3d
@@ -526,8 +527,28 @@ handle_image (void *data, grub_efi_uint32_t datasize)
9d15b4
       goto error_exit;
9d15b4
     }
9d15b4
 
9d15b4
+  /*
9d15b4
+   * The spec says, uselessly, of SectionAlignment:
9d15b4
+   * =====
9d15b4
+   * The alignment (in bytes) of sections when they are loaded into
9d15b4
+   * memory. It must be greater than or equal to FileAlignment. The
9d15b4
+   * default is the page size for the architecture.
9d15b4
+   * =====
9d15b4
+   * Which doesn't tell you whose responsibility it is to enforce the
9d15b4
+   * "default", or when.  It implies that the value in the field must
9d15b4
+   * be > FileAlignment (also poorly defined), but it appears visual
9d15b4
+   * studio will happily write 512 for FileAlignment (its default) and
9d15b4
+   * 0 for SectionAlignment, intending to imply PAGE_SIZE.
9d15b4
+   *
9d15b4
+   * We only support one page size, so if it's zero, nerf it to 4096.
9d15b4
+   */
9d15b4
   section_alignment = context.section_alignment;
9d15b4
+  if (section_alignment == 0)
9d15b4
+    section_alignment = 4096;
9d15b4
+
9d15b4
   buffer_size = context.image_size + section_alignment;
9d15b4
+  grub_dprintf ("chain", "image size is %08lx, datasize is %08x\n",
9d15b4
+	       context.image_size, datasize);
9d15b4
 
6f1e3d
   efi_status = efi_call_3 (b->allocate_pool, GRUB_EFI_LOADER_DATA,
6f1e3d
 			   buffer_size, &buffer);
6f1e3d
@@ -539,7 +560,6 @@ handle_image (void *data, grub_efi_uint32_t datasize)
9d15b4
     }
9d15b4
 
9d15b4
   buffer_aligned = (char *)ALIGN_UP ((grub_addr_t)buffer, section_alignment);
9d15b4
-
9d15b4
   if (!buffer_aligned)
9d15b4
     {
9d15b4
       grub_error (GRUB_ERR_OUT_OF_MEMORY, N_("out of memory"));
6f1e3d
@@ -548,27 +568,62 @@ handle_image (void *data, grub_efi_uint32_t datasize)
9d15b4
 
9d15b4
   grub_memcpy (buffer_aligned, data, context.size_of_headers);
9d15b4
 
9d15b4
+  entry_point = image_address (buffer_aligned, context.image_size,
9d15b4
+			       context.entry_point);
9d15b4
+
9d15b4
+  grub_dprintf ("chain", "entry_point: %p\n", entry_point);
9d15b4
+  if (!entry_point)
9d15b4
+    {
9d15b4
+      grub_error (GRUB_ERR_BAD_ARGUMENT, "invalid entry point");
9d15b4
+      goto error_exit;
9d15b4
+    }
9d15b4
+
9d15b4
   char *reloc_base, *reloc_base_end;
9d15b4
-  reloc_base = image_address (buffer_aligned, datasize,
9d15b4
+  grub_dprintf ("chain", "reloc_dir: %p reloc_size: 0x%08x\n",
9d15b4
+		(void *)(unsigned long long)context.reloc_dir->rva,
9d15b4
+		context.reloc_dir->size);
9d15b4
+  reloc_base = image_address (buffer_aligned, context.image_size,
9d15b4
 			      context.reloc_dir->rva);
9d15b4
   /* RelocBaseEnd here is the address of the last byte of the table */
9d15b4
-  reloc_base_end = image_address (buffer_aligned, datasize,
9d15b4
+  reloc_base_end = image_address (buffer_aligned, context.image_size,
9d15b4
 				  context.reloc_dir->rva
9d15b4
 				  + context.reloc_dir->size - 1);
9d15b4
+  grub_dprintf ("chain", "reloc_base: %p reloc_base_end: %p\n",
9d15b4
+		reloc_base, reloc_base_end);
9d15b4
+
9d15b4
   struct grub_pe32_section_table *reloc_section = NULL;
9d15b4
 
9d15b4
   section = context.first_section;
9d15b4
   for (i = 0; i < context.number_of_sections; i++, section++)
9d15b4
     {
9d15b4
-      size = section->virtual_size;
9d15b4
-      if (size > section->raw_data_size)
9d15b4
-        size = section->raw_data_size;
9d15b4
+      char name[9];
9d15b4
 
9d15b4
       base = image_address (buffer_aligned, context.image_size,
9d15b4
 			    section->virtual_address);
9d15b4
       end = image_address (buffer_aligned, context.image_size,
9d15b4
-			   section->virtual_address + size - 1);
9d15b4
+			   section->virtual_address + section->virtual_size -1);
9d15b4
 
9d15b4
+      grub_strncpy(name, section->name, 9);
9d15b4
+      name[8] = '\0';
9d15b4
+      grub_dprintf ("chain", "Section %d \"%s\" at %p..%p\n", i,
9d15b4
+		   name, base, end);
9d15b4
+
9d15b4
+      if (end < base)
9d15b4
+	{
9d15b4
+	  grub_dprintf ("chain", " base is %p but end is %p... bad.\n",
9d15b4
+		       base, end);
9d15b4
+	  grub_error (GRUB_ERR_BAD_ARGUMENT,
9d15b4
+		      "Image has invalid negative size");
9d15b4
+	  goto error_exit;
9d15b4
+	}
9d15b4
+
9d15b4
+      if (section->virtual_address <= context.entry_point &&
9d15b4
+	  (section->virtual_address + section->raw_data_size - 1)
9d15b4
+	  > context.entry_point)
9d15b4
+	{
9d15b4
+	  found_entry_point++;
9d15b4
+	  grub_dprintf ("chain", " section contains entry point\n");
9d15b4
+	}
9d15b4
 
9d15b4
       /* We do want to process .reloc, but it's often marked
9d15b4
        * discardable, so we don't want to memcpy it. */
6f1e3d
@@ -587,21 +642,46 @@ handle_image (void *data, grub_efi_uint32_t datasize)
9d15b4
 	  if (section->raw_data_size && section->virtual_size &&
9d15b4
 	      base && end && reloc_base == base && reloc_base_end == end)
9d15b4
 	    {
9d15b4
+	      grub_dprintf ("chain", " section is relocation section\n");
9d15b4
 	      reloc_section = section;
9d15b4
 	    }
9d15b4
+	  else
9d15b4
+	    {
9d15b4
+	      grub_dprintf ("chain", " section is not reloc section?\n");
9d15b4
+	      grub_dprintf ("chain", " rds: 0x%08x, vs: %08x\n",
9d15b4
+			    section->raw_data_size, section->virtual_size);
9d15b4
+	      grub_dprintf ("chain", " base: %p end: %p\n", base, end);
9d15b4
+	      grub_dprintf ("chain", " reloc_base: %p reloc_base_end: %p\n",
9d15b4
+			    reloc_base, reloc_base_end);
9d15b4
+	    }
9d15b4
 	}
9d15b4
 
9d15b4
-      if (section->characteristics && GRUB_PE32_SCN_MEM_DISCARDABLE)
9d15b4
-	continue;
9d15b4
+      grub_dprintf ("chain", " Section characteristics are %08x\n",
9d15b4
+		   section->characteristics);
9d15b4
+      grub_dprintf ("chain", " Section virtual size: %08x\n",
9d15b4
+		   section->virtual_size);
9d15b4
+      grub_dprintf ("chain", " Section raw_data size: %08x\n",
9d15b4
+		   section->raw_data_size);
9d15b4
+      if (section->characteristics & GRUB_PE32_SCN_MEM_DISCARDABLE)
9d15b4
+	{
9d15b4
+	  grub_dprintf ("chain", " Discarding section\n");
9d15b4
+	  continue;
9d15b4
+	}
9d15b4
 
9d15b4
       if (!base || !end)
9d15b4
         {
9d15b4
+	  grub_dprintf ("chain", " section is invalid\n");
9d15b4
           grub_error (GRUB_ERR_BAD_ARGUMENT, "Invalid section size");
9d15b4
           goto error_exit;
9d15b4
         }
9d15b4
 
9d15b4
-      if (section->virtual_address < context.size_of_headers ||
9d15b4
-	  section->raw_data_offset < context.size_of_headers)
9d15b4
+      if (section->characteristics & GRUB_PE32_SCN_CNT_UNINITIALIZED_DATA)
9d15b4
+	{
9d15b4
+	  if (section->raw_data_size != 0)
9d15b4
+	    grub_dprintf ("chain", " UNINITIALIZED_DATA section has data?\n");
9d15b4
+	}
9d15b4
+      else if (section->virtual_address < context.size_of_headers ||
9d15b4
+	       section->raw_data_offset < context.size_of_headers)
9d15b4
 	{
9d15b4
 	  grub_error (GRUB_ERR_BAD_ARGUMENT,
9d15b4
 		      "Section %d is inside image headers", i);
6f1e3d
@@ -609,13 +689,24 @@ handle_image (void *data, grub_efi_uint32_t datasize)
9d15b4
 	}
9d15b4
 
9d15b4
       if (section->raw_data_size > 0)
9d15b4
-        grub_memcpy (base, (grub_efi_uint8_t*)data + section->raw_data_offset,
9d15b4
-		     size);
9d15b4
+	{
9d15b4
+	  grub_dprintf ("chain", " copying 0x%08x bytes to %p\n",
9d15b4
+			section->raw_data_size, base);
9d15b4
+	  grub_memcpy (base,
9d15b4
+		       (grub_efi_uint8_t*)data + section->raw_data_offset,
9d15b4
+		       section->raw_data_size);
9d15b4
+	}
9d15b4
 
9d15b4
-      if (size < section->virtual_size)
9d15b4
-        grub_memset (base + size, 0, section->virtual_size - size);
9d15b4
+      if (section->raw_data_size < section->virtual_size)
9d15b4
+	{
9d15b4
+	  grub_dprintf ("chain", " padding with 0x%08x bytes at %p\n",
9d15b4
+			section->virtual_size - section->raw_data_size,
9d15b4
+			base + section->raw_data_size);
9d15b4
+	  grub_memset (base + section->raw_data_size, 0,
9d15b4
+		       section->virtual_size - section->raw_data_size);
9d15b4
+	}
9d15b4
 
9d15b4
-      grub_dprintf ("chain", "copied section %s\n", section->name);
9d15b4
+      grub_dprintf ("chain", " finished section %s\n", name);
9d15b4
     }
9d15b4
 
9d15b4
   /* 5 == EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC */
6f1e3d
@@ -638,12 +729,15 @@ handle_image (void *data, grub_efi_uint32_t datasize)
9d15b4
 	}
9d15b4
     }
9d15b4
 
9d15b4
-  entry_point = image_address (buffer_aligned, context.image_size,
9d15b4
-			       context.entry_point);
9d15b4
-
9d15b4
-  if (!entry_point)
9d15b4
+  if (!found_entry_point)
9d15b4
     {
9d15b4
-      grub_error (GRUB_ERR_BAD_ARGUMENT, "invalid entry point");
9d15b4
+      grub_error (GRUB_ERR_BAD_ARGUMENT, "entry point is not within sections");
9d15b4
+      goto error_exit;
9d15b4
+    }
9d15b4
+  if (found_entry_point > 1)
9d15b4
+    {
9d15b4
+      grub_error (GRUB_ERR_BAD_ARGUMENT, "%d sections contain entry point",
9d15b4
+		  found_entry_point);
9d15b4
       goto error_exit;
9d15b4
     }
9d15b4
 
6f1e3d
@@ -661,26 +755,24 @@ handle_image (void *data, grub_efi_uint32_t datasize)
9d15b4
   li->load_options_size = cmdline_len;
9d15b4
   li->file_path = grub_efi_get_media_file_path (file_path);
9d15b4
   li->device_handle = dev_handle;
9d15b4
-  if (li->file_path)
9d15b4
-    {
9d15b4
-      grub_printf ("file path: ");
9d15b4
-      grub_efi_print_device_path (li->file_path);
9d15b4
-    }
9d15b4
-  else
9d15b4
+  if (!li->file_path)
9d15b4
     {
9d15b4
       grub_error (GRUB_ERR_UNKNOWN_DEVICE, "no matching file path found");
9d15b4
       goto error_exit;
9d15b4
     }
9d15b4
 
9d15b4
+  grub_dprintf ("chain", "booting via entry point\n");
9d15b4
   efi_status = efi_call_2 (entry_point, grub_efi_image_handle,
9d15b4
 			   grub_efi_system_table);
9d15b4
 
6f1e3d
+  grub_dprintf ("chain", "entry_point returned %ld\n", efi_status);
9d15b4
   grub_memcpy (li, &li_bak, sizeof (grub_efi_loaded_image_t));
6f1e3d
   efi_status = efi_call_1 (b->free_pool, buffer);
9d15b4
 
9d15b4
   return 1;
9d15b4
 
9d15b4
 error_exit:
9d15b4
+  grub_dprintf ("chain", "error_exit: grub_errno: %d\n", grub_errno);
9d15b4
   if (buffer)
6f1e3d
       efi_call_1 (b->free_pool, buffer);
9d15b4
 
9d15b4
diff --git a/include/grub/efi/pe32.h b/include/grub/efi/pe32.h
ec4acb
index 6e24dae2cb6..c03cc599f63 100644
9d15b4
--- a/include/grub/efi/pe32.h
9d15b4
+++ b/include/grub/efi/pe32.h
bbc6a8
@@ -229,12 +229,18 @@ struct grub_pe32_section_table
9d15b4
   grub_uint32_t characteristics;
9d15b4
 };
9d15b4
 
9d15b4
+#define GRUB_PE32_SCN_TYPE_NO_PAD		0x00000008
9d15b4
 #define GRUB_PE32_SCN_CNT_CODE			0x00000020
9d15b4
 #define GRUB_PE32_SCN_CNT_INITIALIZED_DATA	0x00000040
9d15b4
-#define GRUB_PE32_SCN_MEM_DISCARDABLE		0x02000000
9d15b4
-#define GRUB_PE32_SCN_MEM_EXECUTE		0x20000000
9d15b4
-#define GRUB_PE32_SCN_MEM_READ			0x40000000
9d15b4
-#define GRUB_PE32_SCN_MEM_WRITE			0x80000000
9d15b4
+#define GRUB_PE32_SCN_CNT_UNINITIALIZED_DATA	0x00000080
9d15b4
+#define GRUB_PE32_SCN_LNK_OTHER			0x00000100
9d15b4
+#define GRUB_PE32_SCN_LNK_INFO			0x00000200
9d15b4
+#define GRUB_PE32_SCN_LNK_REMOVE		0x00000800
9d15b4
+#define GRUB_PE32_SCN_LNK_COMDAT		0x00001000
9d15b4
+#define GRUB_PE32_SCN_GPREL			0x00008000
9d15b4
+#define GRUB_PE32_SCN_MEM_16BIT			0x00020000
9d15b4
+#define GRUB_PE32_SCN_MEM_LOCKED		0x00040000
9d15b4
+#define GRUB_PE32_SCN_MEM_PRELOAD		0x00080000
9d15b4
 
9d15b4
 #define GRUB_PE32_SCN_ALIGN_1BYTES		0x00100000
9d15b4
 #define GRUB_PE32_SCN_ALIGN_2BYTES		0x00200000
bbc6a8
@@ -243,10 +249,28 @@ struct grub_pe32_section_table
9d15b4
 #define GRUB_PE32_SCN_ALIGN_16BYTES		0x00500000
9d15b4
 #define GRUB_PE32_SCN_ALIGN_32BYTES		0x00600000
9d15b4
 #define GRUB_PE32_SCN_ALIGN_64BYTES		0x00700000
9d15b4
+#define GRUB_PE32_SCN_ALIGN_128BYTES		0x00800000
9d15b4
+#define GRUB_PE32_SCN_ALIGN_256BYTES		0x00900000
9d15b4
+#define GRUB_PE32_SCN_ALIGN_512BYTES		0x00A00000
9d15b4
+#define GRUB_PE32_SCN_ALIGN_1024BYTES		0x00B00000
9d15b4
+#define GRUB_PE32_SCN_ALIGN_2048BYTES		0x00C00000
9d15b4
+#define GRUB_PE32_SCN_ALIGN_4096BYTES		0x00D00000
9d15b4
+#define GRUB_PE32_SCN_ALIGN_8192BYTES		0x00E00000
9d15b4
 
9d15b4
 #define GRUB_PE32_SCN_ALIGN_SHIFT		20
9d15b4
 #define GRUB_PE32_SCN_ALIGN_MASK		7
9d15b4
 
9d15b4
+#define GRUB_PE32_SCN_LNK_NRELOC_OVFL		0x01000000
9d15b4
+#define GRUB_PE32_SCN_MEM_DISCARDABLE		0x02000000
9d15b4
+#define GRUB_PE32_SCN_MEM_NOT_CACHED		0x04000000
9d15b4
+#define GRUB_PE32_SCN_MEM_NOT_PAGED		0x08000000
9d15b4
+#define GRUB_PE32_SCN_MEM_SHARED		0x10000000
9d15b4
+#define GRUB_PE32_SCN_MEM_EXECUTE		0x20000000
9d15b4
+#define GRUB_PE32_SCN_MEM_READ			0x40000000
9d15b4
+#define GRUB_PE32_SCN_MEM_WRITE			0x80000000
9d15b4
+
9d15b4
+
9d15b4
+
9d15b4
 #define GRUB_PE32_SIGNATURE_SIZE 4
9d15b4
 
9d15b4
 struct grub_pe32_header