Bundle UEFI firmware for x86-64 QEMU

Author: jacob-carlborg

.github/workflows/bundle.yml

@@ -45,15 +45,35 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+  get_ovmf_uefi_file:
+    name: Get OVMF UEFI files
+    runs-on: ubuntu-latest
+    container: alpine
+    steps:
+      - name: Install OVMF
+        run: apk add ovmf --no-cache
+
+      - name: Persist OVMF file
+        uses: actions/upload-artifact@v4
+        with:
+          name: ovmf_file
+          path: /usr/share/OVMF/OVMF.fd
+          retention-days: 1
+
   build_qemu_macos:
     name: Build QEMU on macOS
     runs-on: macos-11
+    needs: [get_ovmf_uefi_file]
     steps:
       - name: Clone Repository
         uses: actions/checkout@v3
         with:
           persist-credentials: false
 
+      - uses: actions/download-artifact@v4
+        with:
+          name: ovmf_file
+
       - name: Run CI Script
         run: ./ci.rb
 

changelog.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+* Bundle QEMU UEFI for x86-64
+
 ## 0.9.1
 
 ### Bugs Fixed:

ci.rb

@@ -243,52 +243,13 @@ def ldflags
   end
 
   def libslirp
-    @libslirp ||= Libslirp.new
+    ci_runner.host.libslirp
   end
 
   def enabled_architectures
     @enabled_architectures ||=
       ci_runner.enabled_architectures.map { _1.new(self) }
   end
-
-  class Libslirp
-    def build
-      Dir.chdir(temp_dir) do
-        fetch
-        _build
-      end
-    end
-
-    def ldflags
-      [File.join(target_path, "build", "libslirp.a")]
-    end
-
-    def cleanup
-      FileUtils.remove_entry(temp_dir)
-    end
-
-    private
-
-    def temp_dir
-      @temp_dir ||= Dir.mktmpdir
-    end
-
-    def target_path
-      @target_path ||= File.join(temp_dir, "libslirp-master")
-    end
-
-    def fetch
-      download_file("https://gitlab.com/qemu-project/libslirp/-/archive/master/libslirp-master.tar", "libslirp.tar")
-      execute "tar", "-xf", "libslirp.tar"
-    end
-
-    def _build
-      Dir.chdir(target_path) do
-        execute "meson", "setup", "-Ddefault_library=static", "build"
-        execute "ninja", "-C", "build", "install"
-      end
-    end
-  end
 end
 
 class CIRunner
@@ -297,7 +258,6 @@ def run
     qemu.fetch
     qemu.build
     bundle_resources
-    host.xhyve.install
     host.xhyve.bundle
     qemu.bundle
   end
@@ -322,15 +282,15 @@ def qemu_ldflags
     host.qemu.ldflags
   end
 
-  private
-
   def host
     @host ||= begin
       os = Gem::Platform.local.os
       host_map[os]&.new or raise "Unsupported operating system: #{os}"
     end
   end
 
+  private
+
   def host_map
     {
       "darwin" => MacOS,
@@ -376,12 +336,51 @@ def xhyve
       end
     end
 
+    def libslirp
+      @libslirp ||= Libslirp.new
+    end
+
+    def bundle_uefi(firmware_target_dir)
+      FileUtils.cp "OVMF.fd", File.join(firmware_target_dir, "uefi.fd")
+    end
+
     def install_prerequisite
-      packages = %w[ninja pixman glib meson]
+      packages = %w[ninja pixman glib meson libslirp]
       execute "brew", "install", *packages, env: { HOMEBREW_NO_INSTALL_CLEANUP: true }
-    end
+      patch_glib_python_codegen
+    end
+
+    # Python 3.12 doesn't have the distutils module.
+    # Remove when updating to a version of glib newer than 2.78.3.
+    def patch_glib_python_codegen
+      patch = <<~DIFF
+        diff --git a/gio/gdbus-2.0/codegen/utils.py b/gio/gdbus-2.0/codegen/utils.py
+        index 02046108dae49efb140c6438b03b80a73770d2c0..08f1ba9731d0582015ef9807eb739a3efa410e0d 100644
+        --- a/gio/gdbus-2.0/codegen/utils.py
+        +++ b/gio/gdbus-2.0/codegen/utils.py
+        @@ -19,7 +19,7 @@
+         #
+         # Author: David Zeuthen <[email protected]>
+
+        -import distutils.version
+        +import packaging.version
+         import os
+         import sys
+
+        @@ -166,4 +166,4 @@ def version_cmp_key(key):
+                 v = str(key[0])
+             else:
+                 v = "0"
+        -    return (distutils.version.LooseVersion(v), key[1])
+        +    return (packaging.version.Version(v), key[1])
+      DIFF
+
+      Dir.chdir("/usr/local/Cellar/glib/2.78.3/share/glib-2.0") do
+        _, status = Open3.capture2("patch", "-p3", stdin_data: patch)
+        raise "Failed to execute 'patch' command" unless status.success?
+      end
 
-    def bundle_uefi(_firmware_target_dir)
+      execute "pip3", "install", "packaging"
     end
 
     class Qemu < Host::Qemu
@@ -419,70 +418,34 @@ def brew_prefix
     private_constant :Qemu
 
     class Xhyve
+      attr_reader :host
+
       def initialize(host)
         @host = host
       end
 
-      def install
-        execute "brew", "install", "--HEAD", "xhyve"
-      end
-
       def bundle
-        FileUtils.mkdir_p "work/bin"
-        bundle_bhyve_uefi
-        FileUtils.cp Bundler.which("xhyve"), "work/bin"
-        codesign
-
-        xhyve_brew_path = `brew --cellar xhyve`.strip
-        xhyve_version = `brew info xhyve --json | jq .[].installed[].version -r`.strip
-        userboot_path = File.join(xhyve_brew_path, xhyve_version, "share/xhyve/test/userboot.so")
-        FileUtils.cp userboot_path, "work"
-        execute "tar", "-C", "work", "-c", "-f", "xhyve-#{host.name}.tar", "."
-        FileUtils.rm_r "work"
+        # Reuse previously packaged Xhyve because: "xhyve has been disabled because it does not build"
+        # https://github.com/cross-platform-actions/resources/actions/runs/7292733675/job/19874361022#step:3:3225
+        download_file("https://github.com/cross-platform-actions/resources/releases/download/v0.9.1/xhyve-macos.tar", "xhyve-#{host.name}.tar")
       end
+    end
 
-      private
-
-      ENTITLEMENT = <<~XML
-        <?xml version="1.0" encoding="UTF-8"?>
-        <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-        <plist version="1.0">
-        <dict>
-            <key>com.apple.security.hypervisor</key>
-            <true/>
-        </dict>
-        </plist>
-      XML
-
-      attr_reader :host
-
-      def codesign
-        Tempfile.open("entitlement") do |file|
-          file.write ENTITLEMENT
-          file.rewind
+    private_constant :Xhyve
 
-          execute "codesign",
-            "-s", "-",
-            "--entitlements", file.path,
-            "--force",
-            "work/bin/xhyve"
-        end
+    class Libslirp
+      def build
       end
 
-      def bundle_bhyve_uefi
-        work_dir = File.join(Dir.pwd, "work")
+      def ldflags
+        []
+      end
 
-        Dir.mktmpdir do |dir|
-          Dir.chdir(dir) do
-            download_file("https://github.com/cross-platform-actions/resources/releases/download/v0.6.0/xhyve-macos.tar", "xhyve.tar")
-            execute "tar", "xf", "xhyve.tar"
-            FileUtils.mv "uefi.fd", work_dir
-          end
-        end
+      def cleanup
       end
     end
 
-    private_constant :Xhyve
+    private_constant :Libslirp
   end
 
   class Linux < Host
@@ -494,6 +457,10 @@ def xhyve
       @xhyve ||= XhyveNoop.new(self)
     end
 
+    def libslirp
+      @libslirp ||= Libslirp.new
+    end
+
     def install_prerequisite
       packages = %w[
         bash
@@ -534,6 +501,47 @@ def ldflags
     end
 
     private_constant :Qemu
+
+    class Libslirp
+      def build
+        Dir.chdir(temp_dir) do
+          fetch
+          _build
+        end
+      end
+
+      def ldflags
+        [File.join(target_path, "build", "libslirp.a")]
+      end
+
+      def cleanup
+        FileUtils.remove_entry(temp_dir)
+      end
+
+      private
+
+      def temp_dir
+        @temp_dir ||= Dir.mktmpdir
+      end
+
+      def target_path
+        @target_path ||= File.join(temp_dir, "libslirp-master")
+      end
+
+      def fetch
+        download_file("https://gitlab.com/qemu-project/libslirp/-/archive/master/libslirp-master.tar", "libslirp.tar")
+        execute "tar", "-xf", "libslirp.tar"
+      end
+
+      def _build
+        Dir.chdir(target_path) do
+          execute "meson", "setup", "-Ddefault_library=static", "build"
+          execute "ninja", "-C", "build", "install"
+        end
+      end
+    end
+
+    private_constant :Libslirp
   end
 
   class XhyveNoop

test.rb

@@ -52,15 +52,14 @@ def assert_statically_linked(architecture)
   describe "qemu-system" do
     describe "x86_64" do
       it "contains the correct file structure for x86_64" do
-        uefi = QemuSystemValidator.host_os == "macos" ? [] : ["uefi.fd"]
-
         assert_qemu_system "x86_64", firmwares: %w[
           bios-256k.bin
           efi-e1000.rom
           efi-virtio.rom
           kvmvapic.bin
           vgabios-stdvga.bin
-        ].concat(uefi)
+          uefi.fd
+        ]
       end
 
       it "is only linked with system dependencies" do