OvmfPkg: QemuBootOrder: handle QEMU's "-boot strict=on" option

When this option is passed to qemu, it appends the word HALT to the
"bootorder" fw_cfg file, as last entry. For example,

  /pci@i0cf8/ethernet@3/ethernet-phy@0
  /pci@i0cf8/scsi@4/disk@0,0
  HALT

The option's purpose is to prevent SeaBIOS from booting from devices that
have not been specified explicitly (with bootindex=N device properties nor
-boot options). When SeaBIOS sees HALT, it doesn't proceed to boot from
default locations (after boot fails from all of the listed locations).

The HALT string currently causes OVMF to reject the entire "bootorder"
fw_cfg contents, with "parse error". This is not good, because since a
recent libvirt commit, libvirt unconditionally passes "-boot strict=on" to
qemu. Consequently, the boot order logic in QemuBootOrder.c has stopped
working for libvirt users.

OVMF's SetBootOrderFromQemu() function actually implements the idea behind
"-boot strict=on": it drops all boot options not in the fw_cfg list. (*)
Therefore, let's recognize HALT, and just do what we've been doing all
along.

(*) Except the UEFI shell, according to the survival policy in
BootOrderComplete(), but the memory mapped UEFI shell is not expressible
via fw_cfg anyway, and its preservation has been requested on edk2-devel.
Hence it's a good boot option to keep in any case.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15197 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/OvmfPkg/Library/PlatformBdsLib/QemuBootOrder.c b/OvmfPkg/Library/PlatformBdsLib/QemuBootOrder.c
index daab658a1fe5ec6d4ab415baf86970500521ebfa..055cee3ac440027380ea819b62abbdd26fc3c2e4 100644 (file)
--- a/OvmfPkg/Library/PlatformBdsLib/QemuBootOrder.c
+++ b/OvmfPkg/Library/PlatformBdsLib/QemuBootOrder.c
@@ -849,8 +849,11 @@ TranslateOfwNodes (
                                     the current implementation. Further calls\r
                                     to this function are possible.\r
 \r
                                     the current implementation. Further calls\r
                                     to this function are possible.\r
 \r

-  @retval RETURN_NOT_FOUND          Translation terminated, *Ptr was (and is)\r
-                                    pointing to an empty string.\r
+  @retval RETURN_NOT_FOUND          Translation terminated. On input, *Ptr was\r
+                                    pointing to the empty string or "HALT". On\r
+                                    output, *Ptr points to the empty string\r
+                                    (ie. "HALT" is consumed transparently when\r
+                                    present).\r

 \r
   @retval RETURN_INVALID_PARAMETER  Parse error. This is a permanent error.\r
 \r
 \r
   @retval RETURN_INVALID_PARAMETER  Parse error. This is a permanent error.\r
 \r


@@ -870,7 +873,12 @@ TranslateOfwPath (
   OFW_NODE      Skip;\r
 \r
   NumNodes = 0;\r
   OFW_NODE      Skip;\r
 \r
   NumNodes = 0;\r

-  Status = ParseOfwNode (Ptr, &Node[NumNodes], &IsFinal);\r
+  if (AsciiStrCmp (*Ptr, "HALT") == 0) {\r
+    *Ptr += 4;\r
+    Status = RETURN_NOT_FOUND;\r
+  } else {\r
+    Status = ParseOfwNode (Ptr, &Node[NumNodes], &IsFinal);\r
+  }\r

 \r
   if (Status == RETURN_NOT_FOUND) {\r
     DEBUG ((DEBUG_VERBOSE, "%a: no more nodes\n", __FUNCTION__));\r
 \r
   if (Status == RETURN_NOT_FOUND) {\r
     DEBUG ((DEBUG_VERBOSE, "%a: no more nodes\n", __FUNCTION__));\r