Merge pull request #1155 from chancez/pr/chancez/vz_rosetta

Support Rosetta with VZ driver

Author: AkihiroSuda

examples/experimental/vz.yaml

@@ -1,6 +1,10 @@
 # Example to run ubuntu using vmType: vz instead of qemu (Default)
-# This example requires Lima v0.14.0 or later.
+# This example requires Lima v0.14.0 or later and MacOS Ventura.
 vmType: "vz"
+rosetta:
+  enabled: true
+  binfmt: true
+
 images:
 - location: "https://cloud-images.ubuntu.com/releases/22.04/release/ubuntu-22.04-server-cloudimg-amd64.img"
   arch: "x86_64"

pkg/cidata/cidata.TEMPLATE.d/boot/05-rosetta-volume.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+set -eu
+
+if [ "$LIMA_CIDATA_ROSETTA_ENABLED" != "true" ]; then
+	exit 0
+fi
+
+mkdir -p /mnt/lima-rosetta
+mount -t virtiofs vz-rosetta /mnt/lima-rosetta
+
+if [ "$LIMA_CIDATA_ROSETTA_BINFMT" = "true" ]; then
+	echo \
+		':rosetta:M::\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x3e\x00:\xff\xff\xff\xff\xff\xfe\xfe\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff:/mnt/lima-rosetta/rosetta:OCF' \
+		>/proc/sys/fs/binfmt_misc/register
+fi

pkg/cidata/cidata.TEMPLATE.d/lima.env

@@ -27,3 +27,5 @@ LIMA_CIDATA_SLIRP_GATEWAY={{.SlirpGateway}}
 LIMA_CIDATA_SLIRP_IP_ADDRESS={{.SlirpIPAddress}}
 LIMA_CIDATA_UDP_DNS_LOCAL_PORT={{.UDPDNSLocalPort}}
 LIMA_CIDATA_TCP_DNS_LOCAL_PORT={{.TCPDNSLocalPort}}
+LIMA_CIDATA_ROSETTA_ENABLED={{.RosettaEnabled}}
+LIMA_CIDATA_ROSETTA_BINFMT={{.RosettaBinFmt}}

pkg/cidata/cidata.go

@@ -126,6 +126,8 @@ func GenerateISO9660(instDir, name string, y *limayaml.LimaYAML, udpDNSLocalPort
 		SlirpGateway:   networks.SlirpGateway,
 		SlirpDNS:       networks.SlirpDNS,
 		SlirpIPAddress: networks.SlirpIPAddress,
+		RosettaEnabled: y.Rosetta.Enabled,
+		RosettaBinFmt:  y.Rosetta.BinFmt,
 	}
 
 	// change instance id on every boot so network config will be processed again

pkg/cidata/template.go

@@ -71,6 +71,8 @@ type TemplateArgs struct {
 	CACerts            CACerts
 	HostHomeMountPoint string
 	BootCmds           []BootCmds
+	RosettaEnabled     bool
+	RosettaBinFmt      bool
 }
 
 func ValidateTemplateArgs(args TemplateArgs) error {

pkg/limayaml/limayaml.go

@@ -33,6 +33,7 @@ type LimaYAML struct {
 	// `useHostResolver` was deprecated in Lima v0.8.1, removed in Lima v0.14.0. Use `hostResolver.enabled` instead.
 	PropagateProxyEnv *bool          `yaml:"propagateProxyEnv,omitempty" json:"propagateProxyEnv,omitempty"`
 	CACertificates    CACertificates `yaml:"caCerts,omitempty" json:"caCerts,omitempty"`
+	Rosetta           Rosetta        `yaml:"rosetta,omitempty" json:"rosetta,omitempty"`
 }
 
 type Arch = string
@@ -52,6 +53,11 @@ const (
 	VZ   VMType = "vz"
 )
 
+type Rosetta struct {
+	Enabled bool `yaml:"enabled" json:"enabled"`
+	BinFmt  bool `yaml:"binfmt" json:"binfmt"`
+}
+
 type File struct {
 	Location string        `yaml:"location" json:"location"` // REQUIRED
 	Arch     Arch          `yaml:"arch,omitempty" json:"arch,omitempty"`

pkg/vz/errors_darwin.go

@@ -0,0 +1,8 @@
+//go:build darwin && !no_vz
+// +build darwin,!no_vz
+
+package vz
+
+import "errors"
+
+var errRosettaUnsupported = errors.New("Rosetta is unsupported on non-ARM64 hosts")

pkg/vz/rosetta_directory_share.go

@@ -0,0 +1,12 @@
+//go:build darwin && !arm64 && !no_vz
+// +build darwin,!arm64,!no_vz
+
+package vz
+
+import (
+	"github.com/Code-Hex/vz/v3"
+)
+
+func createRosettaDirectoryShareConfiguration() (*vz.VirtioFileSystemDeviceConfiguration, error) {
+	return nil, errRosettaUnsupported
+}

pkg/vz/rosseta_directory_share_arm64.go

@@ -0,0 +1,39 @@
+//go:build darwin && arm64 && !no_vz
+// +build darwin,arm64,!no_vz
+
+package vz
+
+import (
+	"fmt"
+
+	"github.com/Code-Hex/vz/v3"
+	"github.com/sirupsen/logrus"
+)
+
+func createRosettaDirectoryShareConfiguration() (*vz.VirtioFileSystemDeviceConfiguration, error) {
+	config, err := vz.NewVirtioFileSystemDeviceConfiguration("vz-rosetta")
+	if err != nil {
+		return nil, fmt.Errorf("failed to create a new virtio file system configuration: %w", err)
+	}
+	availability := vz.LinuxRosettaDirectoryShareAvailability()
+	switch availability {
+	case vz.LinuxRosettaAvailabilityNotSupported:
+		return nil, errRosettaUnsupported
+	case vz.LinuxRosettaAvailabilityNotInstalled:
+		logrus.Info("Installing rosetta...")
+		if err := vz.LinuxRosettaDirectoryShareInstallRosetta(); err != nil {
+			return nil, fmt.Errorf("failed to install rosetta: %w", err)
+		}
+		logrus.Info("Rosetta installation complete.")
+	case vz.LinuxRosettaAvailabilityInstalled:
+		// nothing to do
+	}
+
+	rosettaShare, err := vz.NewLinuxRosettaDirectoryShare()
+	if err != nil {
+		return nil, fmt.Errorf("failed to create a new rosetta directory share: %w", err)
+	}
+	config.SetDirectoryShare(rosettaShare)
+
+	return config, nil
+}

pkg/vz/vm_darwin.go

@@ -345,6 +345,17 @@ func attachFolderMounts(driver *driver.BaseDriver, vmConfig *vz.VirtualMachineCo
 		config.SetDirectoryShare(share)
 		mounts[i] = config
 	}
+
+	if driver.Yaml.Rosetta.Enabled {
+		logrus.Info("Setting up Rosetta share")
+		directorySharingDeviceConfig, err := createRosettaDirectoryShareConfiguration()
+		if err != nil {
+			logrus.Warnf("Unable to configure Rosetta: %s", err)
+		} else {
+			mounts = append(mounts, directorySharingDeviceConfig)
+		}
+	}
+
 	vmConfig.SetDirectorySharingDevicesVirtualMachineConfiguration(mounts)
 	return nil
 }