Refactor: Remove driver.BaseDriver, move drivers and image-downloader to pkg/driver

pkg/driver/driver.go

@@ -5,16 +5,10 @@ package driver
 
 import (
 	"context"
-	"errors"
 	"net"
-
-	"github.com/lima-vm/lima/pkg/store"
 )
 
 // Driver interface is used by hostagent for managing vm.
-//
-// This interface is extended by BaseDriver which provides default implementation.
-// All other driver definition must extend BaseDriver.
 type Driver interface {
 	// Validate returns error if the current driver isn't support for given config
 	Validate() error
@@ -71,84 +65,7 @@ type Driver interface {
 
 	// GuestAgentConn returns the guest agent connection, or nil (if forwarded by ssh).
 	GuestAgentConn(_ context.Context) (net.Conn, error)
-}
-
-type BaseDriver struct {
-	Instance *store.Instance
-
-	SSHLocalPort int
-	VSockPort    int
-	VirtioPort   string
-}
-
-var _ Driver = (*BaseDriver)(nil)
-
-func (d *BaseDriver) Validate() error {
-	return nil
-}
-
-func (d *BaseDriver) Initialize(_ context.Context) error {
-	return nil
-}
-
-func (d *BaseDriver) CreateDisk(_ context.Context) error {
-	return nil
-}
-
-func (d *BaseDriver) Start(_ context.Context) (chan error, error) {
-	return nil, nil
-}
-
-func (d *BaseDriver) CanRunGUI() bool {
-	return false
-}
-
-func (d *BaseDriver) RunGUI() error {
-	return nil
-}
-
-func (d *BaseDriver) Stop(_ context.Context) error {
-	return nil
-}
-
-func (d *BaseDriver) Register(_ context.Context) error {
-	return nil
-}
-
-func (d *BaseDriver) Unregister(_ context.Context) error {
-	return nil
-}
-
-func (d *BaseDriver) ChangeDisplayPassword(_ context.Context, _ string) error {
-	return nil
-}
-
-func (d *BaseDriver) GetDisplayConnection(_ context.Context) (string, error) {
-	return "", nil
-}
-
-func (d *BaseDriver) CreateSnapshot(_ context.Context, _ string) error {
-	return errors.New("unimplemented")
-}
-
-func (d *BaseDriver) ApplySnapshot(_ context.Context, _ string) error {
-	return errors.New("unimplemented")
-}
-
-func (d *BaseDriver) DeleteSnapshot(_ context.Context, _ string) error {
-	return errors.New("unimplemented")
-}
-
-func (d *BaseDriver) ListSnapshots(_ context.Context) (string, error) {
-	return "", errors.New("unimplemented")
-}
-
-func (d *BaseDriver) ForwardGuestAgent() bool {
-	// if driver is not providing, use host agent
-	return d.VSockPort == 0 && d.VirtioPort == ""
-}
 
-func (d *BaseDriver) GuestAgentConn(_ context.Context) (net.Conn, error) {
-	// use the unix socket forwarded by host agent
-	return nil, nil
+	VSockPort() int
+	VirtioPort() string
 }

pkg/qemu/qemu.go → pkg/driver/qemu/qemu.go

@@ -28,12 +28,12 @@ import (
 	"github.com/sirupsen/logrus"
 
 	"github.com/lima-vm/lima/pkg/fileutils"
-	"github.com/lima-vm/lima/pkg/imgutil/qemuimgutil"
 	"github.com/lima-vm/lima/pkg/iso9660util"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/networks"
 	"github.com/lima-vm/lima/pkg/networks/usernet"
 	"github.com/lima-vm/lima/pkg/osutil"
+	"github.com/lima-vm/lima/pkg/qemuimgutil"
 	"github.com/lima-vm/lima/pkg/store"
 	"github.com/lima-vm/lima/pkg/store/filenames"
 )
@@ -85,50 +85,15 @@ func minimumQemuVersion() (hardMin, softMin semver.Version) {
 }
 
 // EnsureDisk also ensures the kernel and the initrd.
-func EnsureDisk(ctx context.Context, cfg Config) error {
+func EnsureDisk(_ context.Context, cfg Config) error {
 	diffDisk := filepath.Join(cfg.InstanceDir, filenames.DiffDisk)
 	if _, err := os.Stat(diffDisk); err == nil || !errors.Is(err, os.ErrNotExist) {
 		// disk is already ensured
 		return err
 	}
 
 	baseDisk := filepath.Join(cfg.InstanceDir, filenames.BaseDisk)
-	kernel := filepath.Join(cfg.InstanceDir, filenames.Kernel)
-	kernelCmdline := filepath.Join(cfg.InstanceDir, filenames.KernelCmdline)
-	initrd := filepath.Join(cfg.InstanceDir, filenames.Initrd)
-	if _, err := os.Stat(baseDisk); errors.Is(err, os.ErrNotExist) {
-		var ensuredBaseDisk bool
-		errs := make([]error, len(cfg.LimaYAML.Images))
-		for i, f := range cfg.LimaYAML.Images {
-			if _, err := fileutils.DownloadFile(ctx, baseDisk, f.File, true, "the image", *cfg.LimaYAML.Arch); err != nil {
-				errs[i] = err
-				continue
-			}
-			if f.Kernel != nil {
-				if _, err := fileutils.DownloadFile(ctx, kernel, f.Kernel.File, false, "the kernel", *cfg.LimaYAML.Arch); err != nil {
-					errs[i] = err
-					continue
-				}
-				if f.Kernel.Cmdline != "" {
-					if err := os.WriteFile(kernelCmdline, []byte(f.Kernel.Cmdline), 0o644); err != nil {
-						errs[i] = err
-						continue
-					}
-				}
-			}
-			if f.Initrd != nil {
-				if _, err := fileutils.DownloadFile(ctx, initrd, *f.Initrd, false, "the initrd", *cfg.LimaYAML.Arch); err != nil {
-					errs[i] = err
-					continue
-				}
-			}
-			ensuredBaseDisk = true
-			break
-		}
-		if !ensuredBaseDisk {
-			return fileutils.Errors(errs)
-		}
-	}
+
 	diskSize, _ := units.RAMInBytes(*cfg.LimaYAML.Disk)
 	if diskSize == 0 {
 		return nil

pkg/qemu/qemu_driver.go → pkg/driver/qemu/qemu_driver.go

@@ -27,33 +27,42 @@ import (
 	"github.com/sirupsen/logrus"
 
 	"github.com/lima-vm/lima/pkg/driver"
+	"github.com/lima-vm/lima/pkg/driver/qemu/entitlementutil"
 	"github.com/lima-vm/lima/pkg/executil"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/networks/usernet"
 	"github.com/lima-vm/lima/pkg/osutil"
-	"github.com/lima-vm/lima/pkg/qemu/entitlementutil"
 	"github.com/lima-vm/lima/pkg/store"
 	"github.com/lima-vm/lima/pkg/store/filenames"
 )
 
 type LimaQemuDriver struct {
-	*driver.BaseDriver
+	Instance     *store.Instance
+	SSHLocalPort int
+	vSockPort    int
+	virtioPort   string
+
 	qCmd    *exec.Cmd
 	qWaitCh chan error
 
 	vhostCmds []*exec.Cmd
 }
 
-func New(driver *driver.BaseDriver) *LimaQemuDriver {
-	driver.VSockPort = 0
-	driver.VirtioPort = filenames.VirtioPort
+var _ driver.Driver = (*LimaQemuDriver)(nil)
+
+func New(inst *store.Instance, sshLocalPort int) *LimaQemuDriver {
 	// virtserialport doesn't seem to work reliably: https://github.com/lima-vm/lima/issues/2064
 	// but on Windows default Unix socket forwarding is not available
+	var virtioPort string
+	virtioPort = filenames.VirtioPort
 	if runtime.GOOS != "windows" {
-		driver.VirtioPort = ""
+		virtioPort = ""
 	}
 	return &LimaQemuDriver{
-		BaseDriver: driver,
+		Instance:     inst,
+		vSockPort:    0,
+		virtioPort:   virtioPort,
+		SSHLocalPort: sshLocalPort,
 	}
 }
 
@@ -94,7 +103,7 @@ func (l *LimaQemuDriver) Start(ctx context.Context) (chan error, error) {
 		LimaYAML:     l.Instance.Config,
 		SSHLocalPort: l.SSHLocalPort,
 		SSHAddress:   l.Instance.SSHAddress,
-		VirtioGA:     l.VirtioPort != "",
+		VirtioGA:     l.virtioPort != "",
 	}
 	qExe, qArgs, err := Cmdline(ctx, qCfg)
 	if err != nil {
@@ -212,7 +221,7 @@ func (l *LimaQemuDriver) Start(ctx context.Context) (chan error, error) {
 	go func() {
 		if usernetIndex := limayaml.FirstUsernetIndex(l.Instance.Config); usernetIndex != -1 {
 			client := usernet.NewClientByName(l.Instance.Config.Networks[usernetIndex].Lima)
-			err := client.ConfigureDriver(ctx, l.BaseDriver)
+			err := client.ConfigureDriver(ctx, l.Instance, l.SSHLocalPort)
 			if err != nil {
 				l.qWaitCh <- err
 			}
@@ -260,11 +269,11 @@ func (l *LimaQemuDriver) checkBinarySignature() error {
 	}
 	// The codesign --xml option is only available on macOS Monterey and later
 	if !macOSProductVersion.LessThan(*semver.New("12.0.0")) {
-		qExe, _, err := Exe(l.BaseDriver.Instance.Arch)
+		qExe, _, err := Exe(l.Instance.Arch)
 		if err != nil {
-			return fmt.Errorf("failed to find the QEMU binary for the architecture %q: %w", l.BaseDriver.Instance.Arch, err)
+			return fmt.Errorf("failed to find the QEMU binary for the architecture %q: %w", l.Instance.Arch, err)
 		}
-		if accel := Accel(l.BaseDriver.Instance.Arch); accel == "hvf" {
+		if accel := Accel(l.Instance.Arch); accel == "hvf" {
 			entitlementutil.AskToSignIfNotSignedProperly(qExe)
 		}
 	}
@@ -498,3 +507,36 @@ func (a *qArgTemplateApplier) applyTemplate(qArg string) (string, error) {
 	}
 	return b.String(), nil
 }
+
+func (l *LimaQemuDriver) Initialize(_ context.Context) error {
+	return nil
+}
+
+func (l *LimaQemuDriver) CanRunGUI() bool {
+	return false
+}
+
+func (l *LimaQemuDriver) RunGUI() error {
+	return nil
+}
+
+func (l *LimaQemuDriver) Register(_ context.Context) error {
+	return nil
+}
+
+func (l *LimaQemuDriver) Unregister(_ context.Context) error {
+	return nil
+}
+
+func (l *LimaQemuDriver) ForwardGuestAgent() bool {
+	// if driver is not providing, use host agent
+	return l.vSockPort == 0 && l.virtioPort == ""
+}
+
+func (l *LimaQemuDriver) VSockPort() int {
+	return l.vSockPort
+}
+
+func (l *LimaQemuDriver) VirtioPort() string {
+	return l.virtioPort
+}

pkg/driver/vz/disk.go

@@ -0,0 +1,58 @@
+// SPDX-FileCopyrightText: Copyright The Lima Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package vz
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/docker/go-units"
+
+	"github.com/lima-vm/lima/pkg/imgutil/proxyimgutil"
+	"github.com/lima-vm/lima/pkg/iso9660util"
+	"github.com/lima-vm/lima/pkg/store"
+	"github.com/lima-vm/lima/pkg/store/filenames"
+)
+
+func EnsureDisk(_ context.Context, inst *store.Instance) error {
+	diffDisk := filepath.Join(inst.Dir, filenames.DiffDisk)
+	if _, err := os.Stat(diffDisk); err == nil || !errors.Is(err, os.ErrNotExist) {
+		// disk is already ensured
+		return err
+	}
+
+	diskUtil := proxyimgutil.NewDiskUtil()
+
+	baseDisk := filepath.Join(inst.Dir, filenames.BaseDisk)
+
+	diskSize, _ := units.RAMInBytes(*inst.Config.Disk)
+	if diskSize == 0 {
+		return nil
+	}
+	isBaseDiskISO, err := iso9660util.IsISO9660(baseDisk)
+	if err != nil {
+		return err
+	}
+	if isBaseDiskISO {
+		// Create an empty data volume (sparse)
+		diffDiskF, err := os.Create(diffDisk)
+		if err != nil {
+			return err
+		}
+
+		err = diskUtil.MakeSparse(diffDiskF, 0)
+		if err != nil {
+			diffDiskF.Close()
+			return fmt.Errorf("failed to create sparse diff disk %q: %w", diffDisk, err)
+		}
+		return diffDiskF.Close()
+	}
+	if err = diskUtil.ConvertToRaw(baseDisk, diffDisk, &diskSize, false); err != nil {
+		return fmt.Errorf("failed to convert %q to a raw disk %q: %w", baseDisk, diffDisk, err)
+	}
+	return err
+}