Skip to contentSkip to conversation

multiboot2: Implement quirk-modules-after-kernel

PATCH Superseded Zide Chen 2 participants 5 messages Apr 7, 2020 – Apr 17, 2020

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore

Zide Chen

author
#0 lore raw

PATCH v3 1/1 multiboot2: Implement quirk-modules-after-kernel

In contrast to Mulitboot, in Mulitboot2, there is currently no way to control where to load the modules to. This could be a problem, e.g., the OS loaded by Multiboot2 needs to reserve low address for some particular purposes and not for loading modules.

This patch implements the quirk quirk-modules-after-kernel to load modules to address after the kernel for Multiboot2 by reusing the implementation for Multiboot:

- remove "ifndef GRUB_USE_MULTIBOOT2" that is handling this quirk.
- define separate variables for both Multiboot and Multiboot2, e.g., grub_multiboot_quirks, highest_load, etc.
- in grub_multiboot2_load(): calculate the highest load address of raw image and assign it to grub_multiboot2_highest_load.
- the existing code in multiboot_elfxx.c is able to calculate the highest_load for Mutiboot2 already.

Tested on KBL NUC loading ACRN Hypervisor.

v3: update commit messages

---
 grub-core/loader/i386/multiboot_mbi.c |  1 -
 grub-core/loader/multiboot.c          | 23 ++++++++++++-----------
 grub-core/loader/multiboot_elfxx.c    |  7 ++++---
 grub-core/loader/multiboot_mbi2.c     |  2 ++
 include/grub/multiboot.h              |  1 +
 include/grub/multiboot2.h             |  8 ++++++++
 6 files changed, 27 insertions(+), 15 deletions(-)
grub-core/loader/i386/multiboot_mbi.c +0 -1
index ad3cc292fd18..18aaac847011 100644
@@ -63,7 +63,6 @@ static int bootdev_set;
 static grub_size_t elf_sec_num, elf_sec_entsize;
 static unsigned elf_sec_shstrndx;
 static void *elf_sections;
-grub_multiboot_quirks_t grub_multiboot_quirks;
 
 static grub_err_t
 load_kernel (grub_file_t file, const char *filename,
grub-core/loader/multiboot.c +12 -11
index 4a98d7082598..f9f66378dfb2 100644
@@ -32,6 +32,8 @@
 #include <grub/multiboot2.h>
 #define GRUB_MULTIBOOT_CONSOLE_FRAMEBUFFER GRUB_MULTIBOOT2_CONSOLE_FRAMEBUFFER
 #define GRUB_MULTIBOOT_CONSOLE_EGA_TEXT GRUB_MULTIBOOT2_CONSOLE_EGA_TEXT
+#define GRUB_MULTIBOOT_QUIRKS_NONE GRUB_MULTIBOOT2_QUIRKS_NONE
+#define GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL GRUB_MULTIBOOT2_QUIRK_MODULES_AFTER_KERNEL
 #define GRUB_MULTIBOOT(x) grub_multiboot2_ ## x
 #else
 #include <grub/multiboot.h>
@@ -210,7 +212,8 @@ grub_multiboot_unload (void)
   return GRUB_ERR_NONE;
 }
 
-static grub_uint64_t highest_load;
+GRUB_MULTIBOOT (quirks_t) GRUB_MULTIBOOT (quirks);
+grub_uint64_t GRUB_MULTIBOOT (highest_load);
 
 #define MULTIBOOT_LOAD_ELF64
 #include "multiboot_elfxx.c"
@@ -291,32 +294,32 @@ grub_cmd_multiboot (grub_command_t cmd __attribute__ ((unused)),
 
   grub_loader_unset ();
 
-  highest_load = 0;
+  GRUB_MULTIBOOT (highest_load) = 0;
 
-#ifndef GRUB_USE_MULTIBOOT2
-  grub_multiboot_quirks = GRUB_MULTIBOOT_QUIRKS_NONE;
+  GRUB_MULTIBOOT (quirks) = GRUB_MULTIBOOT_QUIRKS_NONE;
   int option_found = 0;
 
   do
     {
       option_found = 0;
+#ifndef GRUB_USE_MULTIBOOT2
       if (argc != 0 && grub_strcmp (argv[0], "--quirk-bad-kludge") == 0)
 	{
 	  argc--;
 	  argv++;
 	  option_found = 1;
-	  grub_multiboot_quirks |= GRUB_MULTIBOOT_QUIRK_BAD_KLUDGE;
+	  GRUB_MULTIBOOT (quirks) |= GRUB_MULTIBOOT_QUIRK_BAD_KLUDGE;
 	}
+#endif
 
       if (argc != 0 && grub_strcmp (argv[0], "--quirk-modules-after-kernel") == 0)
 	{
 	  argc--;
 	  argv++;
 	  option_found = 1;
-	  grub_multiboot_quirks |= GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL;
+	  GRUB_MULTIBOOT (quirks) |= GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL;
 	}
     } while (option_found);
-#endif
 
   if (argc == 0)
     return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("filename expected"));
@@ -392,11 +395,9 @@ grub_cmd_module (grub_command_t cmd __attribute__ ((unused)),
   if (! file)
     return grub_errno;
 
-#ifndef GRUB_USE_MULTIBOOT2
   lowest_addr = 0x100000;
-  if (grub_multiboot_quirks & GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL)
-    lowest_addr = ALIGN_UP (highest_load + 1048576, 4096);
-#endif
+  if (GRUB_MULTIBOOT (quirks) & GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL)
+    lowest_addr = ALIGN_UP (GRUB_MULTIBOOT (highest_load) + 1048576, 4096);
 
   size = grub_file_size (file);
   if (size)
grub-core/loader/multiboot_elfxx.c +4 -3
index 70cd1db513e6..8adce7b3489b 100644
@@ -89,17 +89,18 @@ CONCAT(grub_multiboot_load_elf, XX) (mbi_load_data_t *mld)
     if (phdr(i)->p_type == PT_LOAD)
       {
 	mld->link_base_addr = grub_min (mld->link_base_addr, phdr(i)->p_paddr);
-	highest_load = grub_max (highest_load, phdr(i)->p_paddr + phdr(i)->p_memsz);
+	GRUB_MULTIBOOT (highest_load) = grub_max (GRUB_MULTIBOOT (highest_load),
+			phdr(i)->p_paddr + phdr(i)->p_memsz);
       }
 
 #ifdef MULTIBOOT_LOAD_ELF64
-  if (highest_load >= 0x100000000)
+  if (GRUB_MULTIBOOT(highest_load) >= 0x100000000)
     return grub_error (GRUB_ERR_BAD_OS, "segment crosses 4 GiB border");
 #endif
 
   if (mld->relocatable)
     {
-      load_size = highest_load - mld->link_base_addr;
+      load_size = GRUB_MULTIBOOT(highest_load) - mld->link_base_addr;
 
       grub_dprintf ("multiboot_loader", "align=0x%lx, preference=0x%x, "
 		    "load_size=0x%x, avoid_efi_boot_services=%d\n",
grub-core/loader/multiboot_mbi2.c +2 -0
index 18e766c7b31c..3883732df531 100644
@@ -315,8 +315,10 @@ grub_multiboot2_load (grub_file_t file, const char *filename)
 	  grub_free (mld.buffer);
 	  return err;
 	}
+
       mld.link_base_addr = load_addr;
       mld.load_base_addr = get_physical_target_address (ch);
+      grub_multiboot2_highest_load = mld.load_base_addr + code_size;
       source = get_virtual_current_address (ch);
 
       grub_dprintf ("multiboot_loader", "link_base_addr=0x%x, load_base_addr=0x%x, "
include/grub/multiboot.h +1 -0
index bd0a9873e6c1..3d7c5ad29318 100644
@@ -107,6 +107,7 @@ grub_multiboot_load_elf (mbi_load_data_t *mld);
 extern grub_size_t grub_multiboot_pure_size;
 extern grub_size_t grub_multiboot_alloc_mbi;
 extern grub_uint32_t grub_multiboot_payload_eip;
+extern grub_uint64_t grub_multiboot_highest_load;
 
 
 #endif /* ! GRUB_MULTIBOOT_HEADER */
include/grub/multiboot2.h +8 -0
index 502d34ef1804..fa74508afcda 100644
@@ -27,6 +27,13 @@
 #include <grub/types.h>
 #include <grub/err.h>
 
+typedef enum
+  {
+    GRUB_MULTIBOOT2_QUIRKS_NONE = 0,
+    GRUB_MULTIBOOT2_QUIRK_MODULES_AFTER_KERNEL = 1
+  } grub_multiboot2_quirks_t;
+extern grub_multiboot2_quirks_t grub_multiboot2_quirks;
+
 extern struct grub_relocator *grub_multiboot2_relocator;
 
 void grub_multiboot2 (int argc, char *argv[]);
@@ -99,6 +106,7 @@ grub_multiboot2_load_elf (mbi_load_data_t *mld);
 extern grub_size_t grub_multiboot2_pure_size;
 extern grub_size_t grub_multiboot2_alloc_mbi;
 extern grub_uint32_t grub_multiboot2_payload_eip;
+extern grub_uint64_t grub_multiboot2_highest_load;
 
 
 #endif /* ! GRUB_MULTIBOOT_HEADER */
Signature · 1 line
2.17.1
#1 lore raw
Quoted 5 lines · Zide Chen
grub-core/loader/multiboot.c +0 -0
@@ -392,11 +395,9 @@ grub_cmd_module (grub_command_t cmd __attribute__ ((unused)),
   if (! file)
     return grub_errno;
 

grub-core/loader/multiboot.c grub_cmd_module (grub_command_t cmd __attribute__ ((unused)), · line 403

Quoted 10 lines
grub-core/loader/multiboot.c +2 -4
-#ifndef GRUB_USE_MULTIBOOT2
   lowest_addr = 0x100000;
-  if (grub_multiboot_quirks & GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL)
-    lowest_addr = ALIGN_UP (highest_load + 1048576, 4096);
-#endif
+  if (GRUB_MULTIBOOT (quirks) & GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL)
+    lowest_addr = ALIGN_UP (GRUB_MULTIBOOT (highest_load) + 1048576, 4096);
 
   size = grub_file_size (file);
   if (size)

Hi Zide

Above modification changes another behavior. Before your patch, lowest address for multiboot2 modules allocation was 0x0, now, when you removed #ifndef, it is set to 1MB even if quirk is not enabled. I think that it is worth to mention than in commit message.

To be honest, I was going to submit patch that sets lowest_addr to 0x1000 by default, so from my perspective your 'undocumented' change is good, 1MB works for my project too.

Thanks,
Lukasz

author
#2 lore raw

Hi Lukasz,

Quoted 25 lines

From: Lukasz Hawrylko <[email protected]>
Sent: Tuesday, April 7, 2020 2:20 AM
To: The development of GNU GRUB <[email protected]>
Cc: Chen, Zide <[email protected]>
Subject: Re: [PATCH V3] multiboot2: Implement quirk-modules-after-kernel

Quoted 5 lines · Zide Chen
(quoted diff) +0 -0
@@ -392,11 +395,9 @@ grub_cmd_module (grub_command_t cmd __attribute__ ((unused)),
   if (! file)
     return grub_errno;
 

Review grub_cmd_module (grub_command_t cmd __attribute__ ((unused)), · line 403

Quoted 10 lines
(quoted diff) +2 -4
-#ifndef GRUB_USE_MULTIBOOT2
   lowest_addr = 0x100000;
-  if (grub_multiboot_quirks & GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL)
-    lowest_addr = ALIGN_UP (highest_load + 1048576, 4096);
-#endif
+  if (GRUB_MULTIBOOT (quirks) & GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL)
+    lowest_addr = ALIGN_UP (GRUB_MULTIBOOT (highest_load) + 1048576, 4096);
 
   size = grub_file_size (file);
   if (size)

Hi Zide

Quoted 4 lines

Above modification changes another behavior. Before your patch, lowest address for multiboot2 modules allocation was 0x0, now, when you removed #ifndef, it is set to 1MB even if quirk is not enabled. I think that it is worth to mention than in commit message.

Sure, will update the commit message.

Quoted 3 lines

To be honest, I was going to submit patch that sets lowest_addr to 0x1000 by default, so from my perspective your 'undocumented' change is good, 1MB works for my project too.

This reminds me that I may set the lowest_addr in the following way. It seems to me that the ALIGN_UP to 1MB + 4KB is unnecessary since grub_relocator_alloc_chunk_align() is called with PAGE alignment, and the additional 1MB distance is not needed. But I keep the Multiboot behavior unchanged because I don’t know the background of adding this statement in the first place.

grub-core/loader/multiboot.c +5 -2
index 4a98d7082598..23fd46008aca 100644
@@ -392,11 +392,14 @@ grub_cmd_module (grub_command_t cmd __attribute__ ((unused)),
   if (! file)
     return grub_errno;
 
-#ifndef GRUB_USE_MULTIBOOT2
   lowest_addr = 0x100000;
-  if (grub_multiboot_quirks & GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL)
+  if (grub_multiboot_quirks & GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL) {
+#ifdef GRUB_USE_MULTIBOOT2
+    lowest_addr = highest_load;
+#else
     lowest_addr = ALIGN_UP (highest_load + 1048576, 4096);
 #endif
+  }
 

Thanks,
Zide

author
#3 lore raw
In reply to Lukasz Hawrylko
Quoted 32 lines

-----Original Message-----
From: Lukasz Hawrylko <[email protected]>
Sent: Tuesday, April 7, 2020 2:20 AM
To: The development of GNU GRUB <[email protected]>
Cc: Chen, Zide <[email protected]>
Subject: Re: [PATCH V3] multiboot2: Implement quirk-modules-after-kernel

Quoted 5 lines · Zide Chen
grub-core/loader/multiboot.c +0 -0
@@ -392,11 +395,9 @@ grub_cmd_module (grub_command_t cmd __attribute__ ((unused)),
   if (! file)
     return grub_errno;
 

grub-core/loader/multiboot.c grub_cmd_module (grub_command_t cmd __attribute__ ((unused)), · line 403

Quoted 10 lines
grub-core/loader/multiboot.c +2 -4
-#ifndef GRUB_USE_MULTIBOOT2
   lowest_addr = 0x100000;
-  if (grub_multiboot_quirks & GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL)
-    lowest_addr = ALIGN_UP (highest_load + 1048576, 4096);
-#endif
+  if (GRUB_MULTIBOOT (quirks) & GRUB_MULTIBOOT_QUIRK_MODULES_AFTER_KERNEL)
+    lowest_addr = ALIGN_UP (GRUB_MULTIBOOT (highest_load) + 1048576, 4096);
 
   size = grub_file_size (file);
   if (size)

Hi Zide

Above modification changes another behavior. Before your patch, lowest address for multiboot2 modules allocation was 0x0, now, when you removed #ifndef, it is set to 1MB even if quirk is not enabled. I think that it is worth to mention than in commit message.

Quoted 6 lines

To be honest, I was going to submit patch that sets lowest_addr to 0x1000 by default, so from my perspective your 'undocumented' change is good, 1MB works for my project too.

Thanks,
Lukasz

Hi Lukasz,

I will abandon this patch for now and go to the path to add a new module relocatable tag. If you want you can go ahead to submit your patch to set lowest_addr, which is independent to my new approach.

-Zide

#4 lore raw
Quoted 15 lines · Zide
Quoted 8 lines

Hi Zide

Above modification changes another behavior. Before your patch, lowest address for multiboot2 modules allocation was 0x0, now, when you removed #ifndef, it is set to 1MB even if quirk is not enabled. I think that it is worth to mention than in commit message.

Quoted 6 lines

To be honest, I was going to submit patch that sets lowest_addr to 0x1000 by default, so from my perspective your 'undocumented' change is good, 1MB works for my project too.

Thanks,
Lukasz

Quoted 8 lines

Hi Lukasz,

I will abandon this patch for now and go to the path to add a new module relocatable tag. If you want you can go ahead to submit your patch to set lowest_addr, which is independent to my new approach.

-Zide

Hi Zide

Your new tag will work for me too, because I can set min address there.

Thanks,
Lukasz