[PATCH] OvmfPkg: Skip initrd command on Xcode toolchain

[PATCH] OvmfPkg: Skip initrd command on Xcode toolchain

[Roman Bolshakov]

OVMF booting stops with the assert if built with Xcode on macOS:

  Loading driver at 0x0001FAB8000 EntryPoint=0x0001FABF249 LinuxInitrdDynamicShellCommand.efi
  InstallProtocolInterface: BC62157E-3E33-4FEC-9920-2D3B36D750DF 1F218398
  ProtectUefiImageCommon - 0x1F218140
    - 0x000000001FAB8000 - 0x0000000000008A60

  ASSERT_EFI_ERROR (Status = Unsupported)
  ASSERT LinuxInitrdDynamicShellCommand.c(378): !EFI_ERROR (Status)

The assert comes from InitializeHiiPackage() after an attempt to
retrieve HII package list from ImageHandle.

Xcode still doesn't support HII resource section and
LinuxInitrdDynamicShellCommand depends on it. Likewise 277a3958d93a
("OvmfPkg: Don't include TftpDynamicCommand in XCODE5 tool chain"),
disable initrd command if built with Xcode toolchain

Fixes: 2632178bc683 ("OvmfPkg: add 'initrd' shell command to expose Linux initrd via device path")
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Andrew Fish <afish@apple.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Signed-off-by: Roman Bolshakov <r.bolshakov@yadro.com>
---
 OvmfPkg/OvmfPkgIa32.fdf | 2 +-
 OvmfPkg/OvmfPkgX64.fdf  | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/OvmfPkg/OvmfPkgIa32.fdf b/OvmfPkg/OvmfPkgIa32.fdf
index fd81b6fa8b..e2b759aa8d 100644
--- a/OvmfPkg/OvmfPkgIa32.fdf
+++ b/OvmfPkg/OvmfPkgIa32.fdf
@@ -290,8 +290,8 @@ INF  MdeModulePkg/Universal/Disk/UdfDxe/UdfDxe.inf
 
 !if $(TOOL_CHAIN_TAG) != "XCODE5"
 INF  ShellPkg/DynamicCommand/TftpDynamicCommand/TftpDynamicCommand.inf
-!endif
 INF  OvmfPkg/LinuxInitrdDynamicShellCommand/LinuxInitrdDynamicShellCommand.inf
+!endif
 INF  ShellPkg/Application/Shell/Shell.inf
 
 INF MdeModulePkg/Logo/LogoDxe.inf
diff --git a/OvmfPkg/OvmfPkgX64.fdf b/OvmfPkg/OvmfPkgX64.fdf
index f71134a659..bfca1eff9e 100644
--- a/OvmfPkg/OvmfPkgX64.fdf
+++ b/OvmfPkg/OvmfPkgX64.fdf
@@ -291,8 +291,8 @@ INF  MdeModulePkg/Universal/Disk/UdfDxe/UdfDxe.inf
 
 !if $(TOOL_CHAIN_TAG) != "XCODE5"
 INF  ShellPkg/DynamicCommand/TftpDynamicCommand/TftpDynamicCommand.inf
-!endif
 INF  OvmfPkg/LinuxInitrdDynamicShellCommand/LinuxInitrdDynamicShellCommand.inf
+!endif
 INF  ShellPkg/Application/Shell/Shell.inf
 
 INF MdeModulePkg/Logo/LogoDxe.inf
-- 
2.26.1

Re: [PATCH] OvmfPkg: Skip initrd command on Xcode toolchain

[Philippe Mathieu-Daudé]

On 5/12/20 10:58 PM, Roman Bolshakov wrote:
> OVMF booting stops with the assert if built with Xcode on macOS:
> 
>    Loading driver at 0x0001FAB8000 EntryPoint=0x0001FABF249 LinuxInitrdDynamicShellCommand.efi
>    InstallProtocolInterface: BC62157E-3E33-4FEC-9920-2D3B36D750DF 1F218398
>    ProtectUefiImageCommon - 0x1F218140
>      - 0x000000001FAB8000 - 0x0000000000008A60
> 
>    ASSERT_EFI_ERROR (Status = Unsupported)
>    ASSERT LinuxInitrdDynamicShellCommand.c(378): !EFI_ERROR (Status)
> 
> The assert comes from InitializeHiiPackage() after an attempt to
> retrieve HII package list from ImageHandle.
> 
> Xcode still doesn't support HII resource section and
> LinuxInitrdDynamicShellCommand depends on it. Likewise 277a3958d93a
> ("OvmfPkg: Don't include TftpDynamicCommand in XCODE5 tool chain"),
> disable initrd command if built with Xcode toolchain
> 
> Fixes: 2632178bc683 ("OvmfPkg: add 'initrd' shell command to expose Linux initrd via device path")
> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Andrew Fish <afish@apple.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Signed-off-by: Roman Bolshakov <r.bolshakov@yadro.com>
> ---
>   OvmfPkg/OvmfPkgIa32.fdf | 2 +-
>   OvmfPkg/OvmfPkgX64.fdf  | 2 +-
>   2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/OvmfPkg/OvmfPkgIa32.fdf b/OvmfPkg/OvmfPkgIa32.fdf
> index fd81b6fa8b..e2b759aa8d 100644
> --- a/OvmfPkg/OvmfPkgIa32.fdf
> +++ b/OvmfPkg/OvmfPkgIa32.fdf
> @@ -290,8 +290,8 @@ INF  MdeModulePkg/Universal/Disk/UdfDxe/UdfDxe.inf
>   
>   !if $(TOOL_CHAIN_TAG) != "XCODE5"
>   INF  ShellPkg/DynamicCommand/TftpDynamicCommand/TftpDynamicCommand.inf
> -!endif
>   INF  OvmfPkg/LinuxInitrdDynamicShellCommand/LinuxInitrdDynamicShellCommand.inf
> +!endif
>   INF  ShellPkg/Application/Shell/Shell.inf
>   
>   INF MdeModulePkg/Logo/LogoDxe.inf
> diff --git a/OvmfPkg/OvmfPkgX64.fdf b/OvmfPkg/OvmfPkgX64.fdf
> index f71134a659..bfca1eff9e 100644
> --- a/OvmfPkg/OvmfPkgX64.fdf
> +++ b/OvmfPkg/OvmfPkgX64.fdf
> @@ -291,8 +291,8 @@ INF  MdeModulePkg/Universal/Disk/UdfDxe/UdfDxe.inf
>   
>   !if $(TOOL_CHAIN_TAG) != "XCODE5"
>   INF  ShellPkg/DynamicCommand/TftpDynamicCommand/TftpDynamicCommand.inf
> -!endif
>   INF  OvmfPkg/LinuxInitrdDynamicShellCommand/LinuxInitrdDynamicShellCommand.inf

It looks reasonable.

Acked-by: Philippe Mathieu-Daude <philmd@redhat.com>

> +!endif
>   INF  ShellPkg/Application/Shell/Shell.inf
>   
>   INF MdeModulePkg/Logo/LogoDxe.inf
> 

Re: [PATCH] OvmfPkg: Skip initrd command on Xcode toolchain

[Philippe Mathieu-Daudé]

Hi Olivier,

Adding the EDK2 list back, so other developers can answer to help you too.

On 5/13/20 10:24 AM, LAHAYE Olivier wrote:
> Hi,
> 
> Hi,
> 
> I've tested it (built with the patch) and I can now reach the EFI Shell (with and without HVF) on my MacBook Pro.

Thanks for testing it, this is an implicit "Tested-by: LAHAYE Olivier 
<olivier.lahaye@cea.fr>" tag to this patch.

> Exiting the shell, I can reach a basic setup menu where I was able to setup screen resolution and language.
> The only cherry on the cake I miss is the ability to setup keyboard as fr-mac... Any solution?

It might be worth starting a new thread on the list to ask about this.

Regards,

Phil.

> 
> Cheers,
> 
> Olivier.
> 
> Le 13/05/2020 10:19, « Philippe Mathieu-Daudé » <philmd@redhat.com> a écrit :
> 
>      On 5/12/20 10:58 PM, Roman Bolshakov wrote:
>      > OVMF booting stops with the assert if built with Xcode on macOS:
>      >
>      >    Loading driver at 0x0001FAB8000 EntryPoint=0x0001FABF249 LinuxInitrdDynamicShellCommand.efi
>      >    InstallProtocolInterface: BC62157E-3E33-4FEC-9920-2D3B36D750DF 1F218398
>      >    ProtectUefiImageCommon - 0x1F218140
>      >      - 0x000000001FAB8000 - 0x0000000000008A60
>      >
>      >    ASSERT_EFI_ERROR (Status = Unsupported)
>      >    ASSERT LinuxInitrdDynamicShellCommand.c(378): !EFI_ERROR (Status)
>      >
>      > The assert comes from InitializeHiiPackage() after an attempt to
>      > retrieve HII package list from ImageHandle.
>      >
>      > Xcode still doesn't support HII resource section and
>      > LinuxInitrdDynamicShellCommand depends on it. Likewise 277a3958d93a
>      > ("OvmfPkg: Don't include TftpDynamicCommand in XCODE5 tool chain"),
>      > disable initrd command if built with Xcode toolchain
>      >
>      > Fixes: 2632178bc683 ("OvmfPkg: add 'initrd' shell command to expose Linux initrd via device path")
>      > Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
>      > Cc: Liming Gao <liming.gao@intel.com>
>      > Cc: Andrew Fish <afish@apple.com>
>      > Cc: Laszlo Ersek <lersek@redhat.com>
>      > Signed-off-by: Roman Bolshakov <r.bolshakov@yadro.com>
>      > ---
>      >   OvmfPkg/OvmfPkgIa32.fdf | 2 +-
>      >   OvmfPkg/OvmfPkgX64.fdf  | 2 +-
>      >   2 files changed, 2 insertions(+), 2 deletions(-)
>      >
>      > diff --git a/OvmfPkg/OvmfPkgIa32.fdf b/OvmfPkg/OvmfPkgIa32.fdf
>      > index fd81b6fa8b..e2b759aa8d 100644
>      > --- a/OvmfPkg/OvmfPkgIa32.fdf
>      > +++ b/OvmfPkg/OvmfPkgIa32.fdf
>      > @@ -290,8 +290,8 @@ INF  MdeModulePkg/Universal/Disk/UdfDxe/UdfDxe.inf
>      >
>      >   !if $(TOOL_CHAIN_TAG) != "XCODE5"
>      >   INF  ShellPkg/DynamicCommand/TftpDynamicCommand/TftpDynamicCommand.inf
>      > -!endif
>      >   INF  OvmfPkg/LinuxInitrdDynamicShellCommand/LinuxInitrdDynamicShellCommand.inf
>      > +!endif
>      >   INF  ShellPkg/Application/Shell/Shell.inf
>      >
>      >   INF MdeModulePkg/Logo/LogoDxe.inf
>      > diff --git a/OvmfPkg/OvmfPkgX64.fdf b/OvmfPkg/OvmfPkgX64.fdf
>      > index f71134a659..bfca1eff9e 100644
>      > --- a/OvmfPkg/OvmfPkgX64.fdf
>      > +++ b/OvmfPkg/OvmfPkgX64.fdf
>      > @@ -291,8 +291,8 @@ INF  MdeModulePkg/Universal/Disk/UdfDxe/UdfDxe.inf
>      >
>      >   !if $(TOOL_CHAIN_TAG) != "XCODE5"
>      >   INF  ShellPkg/DynamicCommand/TftpDynamicCommand/TftpDynamicCommand.inf
>      > -!endif
>      >   INF  OvmfPkg/LinuxInitrdDynamicShellCommand/LinuxInitrdDynamicShellCommand.inf
>      
>      It looks reasonable.
>      
>      Acked-by: Philippe Mathieu-Daude <philmd@redhat.com>
>      
>      > +!endif
>      >   INF  ShellPkg/Application/Shell/Shell.inf
>      >
>      >   INF MdeModulePkg/Logo/LogoDxe.inf
>      >
>      
>      
> 

Re: [PATCH] OvmfPkg: Skip initrd command on Xcode toolchain

[Laszlo Ersek]

On 05/12/20 22:58, Roman Bolshakov wrote:
> OVMF booting stops with the assert if built with Xcode on macOS:
> 
>   Loading driver at 0x0001FAB8000 EntryPoint=0x0001FABF249 LinuxInitrdDynamicShellCommand.efi
>   InstallProtocolInterface: BC62157E-3E33-4FEC-9920-2D3B36D750DF 1F218398
>   ProtectUefiImageCommon - 0x1F218140
>     - 0x000000001FAB8000 - 0x0000000000008A60
> 
>   ASSERT_EFI_ERROR (Status = Unsupported)
>   ASSERT LinuxInitrdDynamicShellCommand.c(378): !EFI_ERROR (Status)
> 
> The assert comes from InitializeHiiPackage() after an attempt to
> retrieve HII package list from ImageHandle.
> 
> Xcode still doesn't support HII resource section and
> LinuxInitrdDynamicShellCommand depends on it. Likewise 277a3958d93a
> ("OvmfPkg: Don't include TftpDynamicCommand in XCODE5 tool chain"),
> disable initrd command if built with Xcode toolchain
> 
> Fixes: 2632178bc683 ("OvmfPkg: add 'initrd' shell command to expose Linux initrd via device path")
> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Andrew Fish <afish@apple.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Signed-off-by: Roman Bolshakov <r.bolshakov@yadro.com>
> ---
>  OvmfPkg/OvmfPkgIa32.fdf | 2 +-
>  OvmfPkg/OvmfPkgX64.fdf  | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)

Thanks for the patch!

The reference to commit 277a3958d93a is very welcome.

(1) However, this patch doesn't follow commit 277a3958d93a closely
enough. The present patch only conditionalizes some FDF files. We should
conditionalize the DSC files too, otherwise we're still going to build
LinuxInitrdDynamicShellCommand, just not include it in the firmware.

(2) The "Fixes:" reference is incorrect. Technically, the issue (for
XCODE5) was introduced in the commit that modified the FDF file(s).
Therefore, based on "git-blame", we should have

Fixes: ec41733cfd10

Now, if you look at that commit -- i.e., "OvmfPkg: add the 'initrd'
dynamic shell command" --, then not only will you find the parts in the
DSC files that are necessary to gate (per my point (1) above), you'll
also notice my next point:

(3) The present patch only covers 2 out of the 4 OvmfPkg platforms;
namely, "OvmfPkgIa32X64" and "OvmfXen" are missed.

Please extend the patch to those platforms as well.

In total, the patch should modify 8 files:

OvmfPkg/OvmfPkgIa32.dsc
OvmfPkg/OvmfPkgIa32.fdf
OvmfPkg/OvmfPkgIa32X64.dsc
OvmfPkg/OvmfPkgIa32X64.fdf
OvmfPkg/OvmfPkgX64.dsc
OvmfPkg/OvmfPkgX64.fdf
OvmfPkg/OvmfXen.dsc
OvmfPkg/OvmfXen.fdf

because they all reference
"OvmfPkg/LinuxInitrdDynamicShellCommand/LinuxInitrdDynamicShellCommand.inf".

Thanks!
Laszlo

> 
> diff --git a/OvmfPkg/OvmfPkgIa32.fdf b/OvmfPkg/OvmfPkgIa32.fdf
> index fd81b6fa8b..e2b759aa8d 100644
> --- a/OvmfPkg/OvmfPkgIa32.fdf
> +++ b/OvmfPkg/OvmfPkgIa32.fdf
> @@ -290,8 +290,8 @@ INF  MdeModulePkg/Universal/Disk/UdfDxe/UdfDxe.inf
>  
>  !if $(TOOL_CHAIN_TAG) != "XCODE5"
>  INF  ShellPkg/DynamicCommand/TftpDynamicCommand/TftpDynamicCommand.inf
> -!endif
>  INF  OvmfPkg/LinuxInitrdDynamicShellCommand/LinuxInitrdDynamicShellCommand.inf
> +!endif
>  INF  ShellPkg/Application/Shell/Shell.inf
>  
>  INF MdeModulePkg/Logo/LogoDxe.inf
> diff --git a/OvmfPkg/OvmfPkgX64.fdf b/OvmfPkg/OvmfPkgX64.fdf
> index f71134a659..bfca1eff9e 100644
> --- a/OvmfPkg/OvmfPkgX64.fdf
> +++ b/OvmfPkg/OvmfPkgX64.fdf
> @@ -291,8 +291,8 @@ INF  MdeModulePkg/Universal/Disk/UdfDxe/UdfDxe.inf
>  
>  !if $(TOOL_CHAIN_TAG) != "XCODE5"
>  INF  ShellPkg/DynamicCommand/TftpDynamicCommand/TftpDynamicCommand.inf
> -!endif
>  INF  OvmfPkg/LinuxInitrdDynamicShellCommand/LinuxInitrdDynamicShellCommand.inf
> +!endif
>  INF  ShellPkg/Application/Shell/Shell.inf
>  
>  INF MdeModulePkg/Logo/LogoDxe.inf
> 

Re: [PATCH] OvmfPkg: Skip initrd command on Xcode toolchain

[Roman Bolshakov]

On Wed, May 13, 2020 at 12:23:33PM +0200, Laszlo Ersek wrote:
> On 05/12/20 22:58, Roman Bolshakov wrote:
> > OVMF booting stops with the assert if built with Xcode on macOS:
> > 
> >   Loading driver at 0x0001FAB8000 EntryPoint=0x0001FABF249 LinuxInitrdDynamicShellCommand.efi
> >   InstallProtocolInterface: BC62157E-3E33-4FEC-9920-2D3B36D750DF 1F218398
> >   ProtectUefiImageCommon - 0x1F218140
> >     - 0x000000001FAB8000 - 0x0000000000008A60
> > 
> >   ASSERT_EFI_ERROR (Status = Unsupported)
> >   ASSERT LinuxInitrdDynamicShellCommand.c(378): !EFI_ERROR (Status)
> > 
> > The assert comes from InitializeHiiPackage() after an attempt to
> > retrieve HII package list from ImageHandle.
> > 
> > Xcode still doesn't support HII resource section and
> > LinuxInitrdDynamicShellCommand depends on it. Likewise 277a3958d93a
> > ("OvmfPkg: Don't include TftpDynamicCommand in XCODE5 tool chain"),
> > disable initrd command if built with Xcode toolchain
> > 
> > Fixes: 2632178bc683 ("OvmfPkg: add 'initrd' shell command to expose Linux initrd via device path")
> > Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> > Cc: Liming Gao <liming.gao@intel.com>
> > Cc: Andrew Fish <afish@apple.com>
> > Cc: Laszlo Ersek <lersek@redhat.com>
> > Signed-off-by: Roman Bolshakov <r.bolshakov@yadro.com>
> > ---
> >  OvmfPkg/OvmfPkgIa32.fdf | 2 +-
> >  OvmfPkg/OvmfPkgX64.fdf  | 2 +-
> >  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> Thanks for the patch!
> 
> The reference to commit 277a3958d93a is very welcome.
> 
> (1) However, this patch doesn't follow commit 277a3958d93a closely
> enough. The present patch only conditionalizes some FDF files. We should
> conditionalize the DSC files too, otherwise we're still going to build
> LinuxInitrdDynamicShellCommand, just not include it in the firmware.
> 
> (2) The "Fixes:" reference is incorrect. Technically, the issue (for
> XCODE5) was introduced in the commit that modified the FDF file(s).
> Therefore, based on "git-blame", we should have
> 
> Fixes: ec41733cfd10
> 
> Now, if you look at that commit -- i.e., "OvmfPkg: add the 'initrd'
> dynamic shell command" --, then not only will you find the parts in the
> DSC files that are necessary to gate (per my point (1) above), you'll
> also notice my next point:
> 
> (3) The present patch only covers 2 out of the 4 OvmfPkg platforms;
> namely, "OvmfPkgIa32X64" and "OvmfXen" are missed.
> 
> Please extend the patch to those platforms as well.
> 
> In total, the patch should modify 8 files:
> 
> OvmfPkg/OvmfPkgIa32.dsc
> OvmfPkg/OvmfPkgIa32.fdf
> OvmfPkg/OvmfPkgIa32X64.dsc
> OvmfPkg/OvmfPkgIa32X64.fdf
> OvmfPkg/OvmfPkgX64.dsc
> OvmfPkg/OvmfPkgX64.fdf
> OvmfPkg/OvmfXen.dsc
> OvmfPkg/OvmfXen.fdf
> 
> because they all reference
> "OvmfPkg/LinuxInitrdDynamicShellCommand/LinuxInitrdDynamicShellCommand.inf".
> 

Hi Laszlo,

Thanks for the feedback and pointing me out to other places I missed.
I will address the issues shortly.

Regards,
Roman