Skip to contentSkip to conversation

search: new --efidisk-only option on EFI systems

PATCH In review Renaud Métrich 2 participants 5 messages Mar 7, 2022 – Mar 24, 2022

lore
Share & tools
lore
#0 lore raw

v5 cover search: new --efidisk-only option on EFI systems

When using 'search' on EFI systems, we sometimes want to exclude devices that are not EFI disks (e.g. md, lvm).
This is typically used when wanting to chainload when having a software raid (md) for EFI partition:
with no option, 'search --file /EFI/redhat/shimx64.efi' sets root envvar to 'md/boot_efi' which cannot be used for chainloading since there is no effective EFI device behind.

This set of patches also refactor handling of --no-floppy option.

Changes in this version compared to reviewed one (PATCH v3, by Daniel):

- split --no-floppy refactoring (patch 2/3)
- fixed unitialized declaration of stack variable 'flags' (patch 2/3)
- documented --efidisk-only option (patch 3/3)

#1 lore raw

PATCH v5 1/3 search: fixed bug stopping iteration when --no-floppy is used

When using --no-floppy and a floppy was encountered, iterate_device() was returning 1, causing the iteration to stop instead of continuing.

---
 grub-core/commands/search.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
grub-core/commands/search.c +1 -1
index ed090b3af..51656e361 100644
@@ -64,7 +64,7 @@ iterate_device (const char *name, void *data)
   /* Skip floppy drives when requested.  */
   if (ctx->no_floppy &&
       name[0] == 'f' && name[1] == 'd' && name[2] >= '0' && name[2] <= '9')
-    return 1;
+    return 0;
 
 #ifdef DO_SEARCH_FS_UUID
 #define compare_fn grub_strcasecmp
Signature · 1 line
2.35.1
#2 lore raw

PATCH v5 2/3 search: refactor --no-floppy option to have something generic

In reply to Renaud Métrich
---
 grub-core/commands/search.c      |  8 ++++----
 grub-core/commands/search_wrap.c | 13 +++++++------
 include/grub/search.h            | 14 +++++++++++---
 3 files changed, 22 insertions(+), 13 deletions(-)
grub-core/commands/search.c +4 -4
index 51656e361..197eccdf8 100644
@@ -47,7 +47,7 @@ struct search_ctx
 {
   const char *key;
   const char *var;
-  int no_floppy;
+  enum search_flags flags;
   char **hints;
   unsigned nhints;
   int count;
@@ -62,7 +62,7 @@ iterate_device (const char *name, void *data)
   int found = 0;
 
   /* Skip floppy drives when requested.  */
-  if (ctx->no_floppy &&
+  if (ctx->flags & SEARCH_FLAGS_NO_FLOPPY &&
       name[0] == 'f' && name[1] == 'd' && name[2] >= '0' && name[2] <= '9')
     return 0;
 
@@ -261,13 +261,13 @@ try (struct search_ctx *ctx)
 }
 
 void
-FUNC_NAME (const char *key, const char *var, int no_floppy,
+FUNC_NAME (const char *key, const char *var, enum search_flags flags,
 	   char **hints, unsigned nhints)
 {
   struct search_ctx ctx = {
     .key = key,
     .var = var,
-    .no_floppy = no_floppy,
+    .flags = flags,
     .hints = hints,
     .nhints = nhints,
     .count = 0,
grub-core/commands/search_wrap.c +7 -6
index 47fc8eb99..8e90bbdcc 100644
@@ -89,6 +89,7 @@ grub_cmd_search (grub_extcmd_context_t ctxt, int argc, char **args)
   const char *id = 0;
   int i = 0, j = 0, nhints = 0;
   char **hints = NULL;
+  enum search_flags flags = 0;
 
   if (state[SEARCH_HINT].set)
     for (i = 0; state[SEARCH_HINT].args[i]; i++)
@@ -180,15 +181,15 @@ grub_cmd_search (grub_extcmd_context_t ctxt, int argc, char **args)
       goto out;
     }
 
+  if (state[SEARCH_NO_FLOPPY].set)
+    flags |= SEARCH_FLAGS_NO_FLOPPY;
+
   if (state[SEARCH_LABEL].set)
-    grub_search_label (id, var, state[SEARCH_NO_FLOPPY].set, 
-		       hints, nhints);
+    grub_search_label (id, var, flags, hints, nhints);
   else if (state[SEARCH_FS_UUID].set)
-    grub_search_fs_uuid (id, var, state[SEARCH_NO_FLOPPY].set,
-			 hints, nhints);
+    grub_search_fs_uuid (id, var, flags, hints, nhints);
   else if (state[SEARCH_FILE].set)
-    grub_search_fs_file (id, var, state[SEARCH_NO_FLOPPY].set, 
-			 hints, nhints);
+    grub_search_fs_file (id, var, flags, hints, nhints);
   else
     grub_error (GRUB_ERR_INVALID_COMMAND, "unspecified search type");
 
include/grub/search.h +11 -3
index d80347df3..bbfa6a787 100644
@@ -19,11 +19,19 @@
 #ifndef GRUB_SEARCH_HEADER
 #define GRUB_SEARCH_HEADER 1
 
-void grub_search_fs_file (const char *key, const char *var, int no_floppy,
+enum search_flags
+  {
+    SEARCH_FLAGS_NO_FLOPPY	= 1
+  };
+
+void grub_search_fs_file (const char *key, const char *var,
+			  enum search_flags flags,
 			  char **hints, unsigned nhints);
-void grub_search_fs_uuid (const char *key, const char *var, int no_floppy,
+void grub_search_fs_uuid (const char *key, const char *var,
+			  enum search_flags flags,
 			  char **hints, unsigned nhints);
-void grub_search_label (const char *key, const char *var, int no_floppy,
+void grub_search_label (const char *key, const char *var,
+			enum search_flags flags,
 			char **hints, unsigned nhints);
 
 #endif
Signature · 1 line
2.35.1
#3 lore raw

PATCH v5 3/3 search: new --efidisk-only option on EFI systems

In reply to Renaud Métrich

When using 'search' on EFI systems, we sometimes want to exclude devices that are not EFI disks (e.g. md, lvm).
This is typically used when wanting to chainload when having a software raid (md) for EFI partition:
with no option, 'search --file /EFI/redhat/shimx64.efi' sets root envvar to 'md/boot_efi' which cannot be used for chainloading since there is no effective EFI device behind.

---
 docs/grub.texi                   |  5 ++++-
 grub-core/commands/search.c      | 19 +++++++++++++++++++
 grub-core/commands/search_wrap.c |  5 +++++
 include/grub/search.h            |  3 ++-
 4 files changed, 30 insertions(+), 2 deletions(-)
docs/grub.texi +4 -1
index a72d73ce3..acdb479e0 100644
@@ -5003,7 +5003,7 @@ unbootable. @xref{Using digital signatures}, for more information.
 
 @deffn Command search @
  [@option{--file}|@option{--label}|@option{--fs-uuid}] @
- [@option{--set} [var]] [@option{--no-floppy}] name
+ [@option{--set} [var]] [@option{--no-floppy}|@option{--efidisk-only}] name
 Search devices by file (@option{-f}, @option{--file}), filesystem label
 (@option{-l}, @option{--label}), or filesystem UUID (@option{-u},
 @option{--fs-uuid}).
@@ -5015,6 +5015,9 @@ set as the value of environment variable @var{var}. The default variable is
 The (@option{-n}, @option{--no-floppy}) option prevents searching floppy
 devices, which can be slow.
 
+The (@option{--efidisk-only}) option prevents searching any other devices then
+EFI disks. This is typically used when chainloading to local EFI partition.
+
 The @samp{search.file}, @samp{search.fs_label}, and @samp{search.fs_uuid}
 commands are aliases for @samp{search --file}, @samp{search --label}, and
 @samp{search --fs-uuid} respectively.
grub-core/commands/search.c +19 -0
index 197eccdf8..57d26ced8 100644
@@ -66,6 +66,25 @@ iterate_device (const char *name, void *data)
       name[0] == 'f' && name[1] == 'd' && name[2] >= '0' && name[2] <= '9')
     return 0;
 
+  /* Limit to EFI disks when requested.  */
+  if (ctx->flags & SEARCH_FLAGS_EFIDISK_ONLY)
+    {
+      grub_device_t dev;
+      dev = grub_device_open (name);
+      if (! dev)
+	{
+	  grub_errno = GRUB_ERR_NONE;
+	  return 0;
+	}
+      if (! dev->disk || dev->disk->dev->id != GRUB_DISK_DEVICE_EFIDISK_ID)
+	{
+	  grub_device_close (dev);
+	  grub_errno = GRUB_ERR_NONE;
+	  return 0;
+	}
+      grub_device_close (dev);
+    }
+
 #ifdef DO_SEARCH_FS_UUID
 #define compare_fn grub_strcasecmp
 #else
grub-core/commands/search_wrap.c +5 -0
index 8e90bbdcc..0b62acf85 100644
@@ -40,6 +40,7 @@ static const struct grub_arg_option options[] =
      N_("Set a variable to the first device found."), N_("VARNAME"),
      ARG_TYPE_STRING},
     {"no-floppy",	'n', 0, N_("Do not probe any floppy drive."), 0, 0},
+    {"efidisk-only",	0, 0, N_("Only probe EFI disks."), 0, 0},
     {"hint",	        'h', GRUB_ARG_OPTION_REPEATABLE,
      N_("First try the device HINT. If HINT ends in comma, "
 	"also try subpartitions"), N_("HINT"), ARG_TYPE_STRING},
@@ -73,6 +74,7 @@ enum options
     SEARCH_FS_UUID,
     SEARCH_SET,
     SEARCH_NO_FLOPPY,
+    SEARCH_EFIDISK_ONLY,
     SEARCH_HINT,
     SEARCH_HINT_IEEE1275,
     SEARCH_HINT_BIOS,
@@ -184,6 +186,9 @@ grub_cmd_search (grub_extcmd_context_t ctxt, int argc, char **args)
   if (state[SEARCH_NO_FLOPPY].set)
     flags |= SEARCH_FLAGS_NO_FLOPPY;
 
+  if (state[SEARCH_EFIDISK_ONLY].set)
+    flags |= SEARCH_FLAGS_EFIDISK_ONLY;
+
   if (state[SEARCH_LABEL].set)
     grub_search_label (id, var, flags, hints, nhints);
   else if (state[SEARCH_FS_UUID].set)
include/grub/search.h +2 -1
index bbfa6a787..4190aeb2c 100644
@@ -21,7 +21,8 @@
 
 enum search_flags
   {
-    SEARCH_FLAGS_NO_FLOPPY	= 1
+    SEARCH_FLAGS_NO_FLOPPY	= 1,
+    SEARCH_FLAGS_EFIDISK_ONLY	= 2
   };
 
 void grub_search_fs_file (const char *key, const char *var,
Signature · 1 line
2.35.1
#4 lore raw
In reply to Renaud Métrich
Quoted 8 lines · Renaud Métrich

When using 'search' on EFI systems, we sometimes want to exclude devices that are not EFI disks (e.g. md, lvm).
This is typically used when wanting to chainload when having a software raid (md) for EFI partition:
with no option, 'search --file /EFI/redhat/shimx64.efi' sets root envvar to 'md/boot_efi' which cannot be used for chainloading since there is no effective EFI device behind.

Quoted 7 lines

This set of patches also refactor handling of --no-floppy option.

Changes in this version compared to reviewed one (PATCH v3, by Daniel):

- split --no-floppy refactoring (patch 2/3)
- fixed unitialized declaration of stack variable 'flags' (patch 2/3)
- documented --efidisk-only option (patch 3/3)

For both patches Reviewed-by: Daniel Kiper <[email protected]>...

There are a few nits but I will fix them for you this time.

Daniel