-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
firmware: fetch EDK2 firmware instead of Rust Hypervisor Firmware
To work around cloud-hypervisor/rust-hypervisor-firmware#298.
- Loading branch information
Showing
4 changed files
with
171 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,145 @@ | ||
| package firmware | ||
|
|
||
| import ( | ||
| "bufio" | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "github.com/cirruslabs/vetu/internal/binaryfetcher" | ||
| "github.com/samber/lo" | ||
| "io" | ||
| "net/http" | ||
| "os" | ||
| "path" | ||
| "pault.ag/go/debian/control" | ||
| "pault.ag/go/debian/deb" | ||
| "runtime" | ||
| ) | ||
|
|
||
| const ( | ||
| edk2BinaryPath = "/usr/share/cloud-hypervisor/CLOUDHV_EFI.fd" | ||
| baseURL = "https://github.com/cirruslabs/rust-hypervisor-firmware/releases/latest/download/" | ||
| ) | ||
| systemEDKPath = "/usr/share/cloud-hypervisor/CLOUDHV_EFI.fd" | ||
|
|
||
| var goarchToDownloadURL = map[string]string{ | ||
| "amd64": baseURL + "hypervisor-fw", | ||
| "arm64": baseURL + "hypervisor-fw-aarch64", | ||
| } | ||
| debRepositoryURL = "https://download.opensuse.org/repositories/home:/cloud-hypervisor/xUbuntu_22.04" | ||
| debTargetPackage = "edk2-cloud-hypervisor" | ||
| debTargetFilename = "CLOUDHV_EFI.fd" | ||
| ) | ||
|
|
||
| func Firmware(ctx context.Context) (string, string, error) { | ||
| // Always prefer the EDK2 firmware installed on the system | ||
| _, err := os.Stat(edk2BinaryPath) | ||
| _, err := os.Stat(systemEDKPath) | ||
| if err == nil { | ||
| return edk2BinaryPath, "EDK2 firmware", nil | ||
| return systemEDKPath, "EDK2 firmware", nil | ||
| } | ||
|
|
||
| // Fall back to downloading the Rust Hypervisor Firmware from GitHub | ||
| downloadURL, ok := goarchToDownloadURL[runtime.GOARCH] | ||
| // Fall back to downloading the EDK2 firmware from a .deb-repository | ||
| fmt.Printf("no EDK2 firmware installed on the system, downloading it from %s...\n", | ||
| debRepositoryURL) | ||
|
|
||
| binaryPath, err := binaryfetcher.FetchBy(ctx, func(binaryFile io.Writer) error { | ||
| // Fetch the Packages file to determine the appropriate .deb | ||
| // that'll run on runtime.GOARCH | ||
| debURL, err := determineDebURL(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Fetch the .deb file and extract the firmware contents to binaryFile | ||
| return downloadAndExtractDeb(ctx, debURL, binaryFile) | ||
| }, debTargetFilename, true) | ||
| if err != nil { | ||
| return "", "", err | ||
| } | ||
|
|
||
| return binaryPath, "downloaded EDK2 firmware", nil | ||
| } | ||
|
|
||
| func determineDebURL(ctx context.Context) (string, error) { | ||
| // Fetch the Packages file and parse it | ||
| resp, err := fetch(ctx, debRepositoryURL+"/Packages") | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| sources, err := control.ParseBinaryIndex(bufio.NewReader(resp.Body)) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| // Find the package that contains EDK2 firmware for the current architecture | ||
| edk2Source, ok := lo.Find(sources, func(source control.BinaryIndex) bool { | ||
| return source.Package == debTargetPackage && source.Architecture.CPU == runtime.GOARCH | ||
| }) | ||
| if !ok { | ||
| return "", "", fmt.Errorf("no EDK2 firmware installed on the system "+ | ||
| "and architecture %q is not available in Rust Hypervisor Firmware's GitHub releases", runtime.GOARCH) | ||
| return "", fmt.Errorf("cannot find edk2-cloud-hypervisor package for %v in the repository", | ||
| runtime.GOARCH) | ||
| } | ||
|
|
||
| fmt.Printf("no EDK2 firmware installed on the system, downloading Rust Hypervisor Firmware "+ | ||
| "from %s...\n", downloadURL) | ||
| return debRepositoryURL + "/" + edk2Source.Filename, nil | ||
| } | ||
|
|
||
| binaryPath, err := binaryfetcher.Fetch(ctx, downloadURL, "hypervisor-fw", true) | ||
| func downloadAndExtractDeb(ctx context.Context, debURL string, binaryFile io.Writer) error { | ||
| // Fetch the .deb package and parse it | ||
| debPath, err := fetchToFile(ctx, debURL) | ||
| if err != nil { | ||
| return "", "", err | ||
| return err | ||
| } | ||
| defer os.Remove(debPath) | ||
|
|
||
| parsedDeb, debCloser, err := deb.LoadFile(debPath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer func() { | ||
| _ = debCloser() | ||
| }() | ||
|
|
||
| // Iterate over .deb package data files and look for EDK2 firmware | ||
| for { | ||
| next, err := parsedDeb.Data.Next() | ||
| if err != nil { | ||
| if errors.Is(err, io.EOF) { | ||
| return fmt.Errorf("cannot find %s file in the %s package", debTargetFilename, | ||
| debURL) | ||
| } | ||
|
|
||
| return err | ||
| } | ||
|
|
||
| if path.Base(next.Name) == debTargetFilename { | ||
| _, err := io.Copy(binaryFile, parsedDeb.Data) | ||
|
|
||
| return err | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func fetchToFile(ctx context.Context, url string) (string, error) { | ||
| resp, err := fetch(ctx, url) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| tempFile, err := os.CreateTemp("", "") | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| if _, err := io.Copy(tempFile, resp.Body); err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| return tempFile.Name(), tempFile.Close() | ||
| } | ||
|
|
||
| func fetch(ctx context.Context, url string) (*http.Response, error) { | ||
| client := http.Client{} | ||
|
|
||
| request, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return binaryPath, "Rust Hypervisor Firmware", nil | ||
| return client.Do(request) | ||
| } |