Support for display with vz driver

balajiv113 · balajiv113 · commit d57d50d2804b · 2023-06-01T22:58:43.000+05:30
Signed-off-by: Balaji Vijayakumar &lt;kuttibalaji.v6@gmail.com&gt;
diff --git a/pkg/driver/driver.go b/pkg/driver/driver.go
@@ -13,7 +13,9 @@ type Driver interface {
 
 	CreateDisk() error
 
-	Start(_ context.Context) (chan error, error)
+	Start(_ context.Context) (bool, chan error, error)
+
+	StartGUI() error
 
 	Stop(_ context.Context) error
 
@@ -45,8 +47,12 @@ func (d *BaseDriver) CreateDisk() error {
 	return nil
 }
 
-func (d *BaseDriver) Start(_ context.Context) (chan error, error) {
-	return nil, nil
+func (d *BaseDriver) Start(_ context.Context) (bool, chan error, error) {
+	return false, nil, nil
+}
+
+func (d *BaseDriver) StartGUI() error {
+	return nil
 }
 
 func (d *BaseDriver) Stop(_ context.Context) error {
diff --git a/pkg/hostagent/hostagent.go b/pkg/hostagent/hostagent.go
@@ -286,7 +286,7 @@ func (a *HostAgent) Run(ctx context.Context) error {
 		}
 		defer dnsServer.Shutdown()
 	}
-	errCh, err := a.driver.Start(ctx)
+	startGui, errCh, err := a.driver.Start(ctx)
 	if err != nil {
 		return err
 	}
@@ -335,12 +335,22 @@ func (a *HostAgent) Run(ctx context.Context) error {
 		logrus.Infof("VNC Password: `%s`", vncpwdfile)
 	}
 
+	if startGui {
+		go func() {
+			err = a.startRoutinesAndWait(ctx, errCh)
+			logrus.Error(err)
+		}()
+		return a.driver.StartGUI()
+	}
+	return a.startRoutinesAndWait(ctx, errCh)
+}
+
+func (a *HostAgent) startRoutinesAndWait(ctx context.Context, errCh chan error) error {
 	stBase := events.Status{
 		SSHLocalPort: a.sshLocalPort,
 	}
 	stBooting := stBase
 	a.emitEvent(ctx, events.Event{Status: stBooting})
-
 	ctxHA, cancelHA := context.WithCancel(ctx)
 	go func() {
 		stRunning := stBase
@@ -351,7 +361,6 @@ func (a *HostAgent) Run(ctx context.Context) error {
 		stRunning.Running = true
 		a.emitEvent(ctx, events.Event{Status: stRunning})
 	}()
-
 	for {
 		select {
 		case driverErr := <-errCh:
diff --git a/pkg/qemu/qemu_driver.go b/pkg/qemu/qemu_driver.go
@@ -58,7 +58,7 @@ func (l *LimaQemuDriver) CreateDisk() error {
 	return nil
 }
 
-func (l *LimaQemuDriver) Start(ctx context.Context) (chan error, error) {
+func (l *LimaQemuDriver) Start(ctx context.Context) (bool, chan error, error) {
 	qCfg := Config{
 		Name:         l.Instance.Name,
 		InstanceDir:  l.Instance.Dir,
@@ -67,35 +67,35 @@ func (l *LimaQemuDriver) Start(ctx context.Context) (chan error, error) {
 	}
 	qExe, qArgs, err := Cmdline(qCfg)
 	if err != nil {
-		return nil, err
+		return false, nil, err
 	}
 
 	var qArgsFinal []string
 	applier := &qArgTemplateApplier{}
 	for _, unapplied := range qArgs {
 		applied, err := applier.applyTemplate(unapplied)
 		if err != nil {
-			return nil, err
+			return false, nil, err
 		}
 		qArgsFinal = append(qArgsFinal, applied)
 	}
 	qCmd := exec.CommandContext(ctx, qExe, qArgsFinal...)
 	qCmd.ExtraFiles = append(qCmd.ExtraFiles, applier.files...)
 	qStdout, err := qCmd.StdoutPipe()
 	if err != nil {
-		return nil, err
+		return false, nil, err
 	}
 	go logPipeRoutine(qStdout, "qemu[stdout]")
 	qStderr, err := qCmd.StderrPipe()
 	if err != nil {
-		return nil, err
+		return false, nil, err
 	}
 	go logPipeRoutine(qStderr, "qemu[stderr]")
 
 	logrus.Infof("Starting QEMU (hint: to watch the boot progress, see %q)", filepath.Join(qCfg.InstanceDir, filenames.SerialLog))
 	logrus.Debugf("qCmd.Args: %v", qCmd.Args)
 	if err := qCmd.Start(); err != nil {
-		return nil, err
+		return false, nil, err
 	}
 	l.qCmd = qCmd
 	l.qWaitCh = make(chan error)
@@ -108,7 +108,7 @@ func (l *LimaQemuDriver) Start(ctx context.Context) (chan error, error) {
 			err = client.ResolveAndForwardSSH(limayaml.MACAddress(l.Instance.Dir), l.SSHLocalPort)
 		}
 	}()
-	return l.qWaitCh, nil
+	return false, l.qWaitCh, nil
 }
 
 func (l *LimaQemuDriver) Stop(ctx context.Context) error {
diff --git a/pkg/vz/vm_darwin.go b/pkg/vz/vm_darwin.go
@@ -499,7 +499,7 @@ func attachDisks(driver *driver.BaseDriver, vmConfig *vz.VirtualMachineConfigura
 }
 
 func attachDisplay(driver *driver.BaseDriver, vmConfig *vz.VirtualMachineConfiguration) error {
-	if driver.Yaml.Video.Display != nil {
+	if *driver.Yaml.Video.Display == "vz" {
 		graphicsDeviceConfiguration, err := vz.NewVirtioGraphicsDeviceConfiguration()
 		if err != nil {
 			return err
diff --git a/pkg/vz/vz_driver_darwin.go b/pkg/vz/vz_driver_darwin.go
@@ -8,6 +8,7 @@ import (
 	"errors"
 	"fmt"
 	"path/filepath"
+	"runtime"
 	"time"
 
 	"github.com/lima-vm/lima/pkg/reflectutil"
@@ -29,6 +30,11 @@ type LimaVzDriver struct {
 	machine *virtualMachineWrapper
 }
 
+func init() {
+	//Without this the call to StartGraphicApplication fails. This has to be called before the vz cgo loads
+	runtime.LockOSThread()
+}
+
 func New(driver *driver.BaseDriver) *LimaVzDriver {
 	return &LimaVzDriver{
 		BaseDriver: driver,
@@ -72,6 +78,7 @@ func (l *LimaVzDriver) Validate() error {
 		"Rosetta",
 		"AdditionalDisks",
 		"Audio",
+		"Video",
 	); len(unknown) > 0 {
 		logrus.Warnf("Ignoring: vmType %s: %+v", *l.Yaml.VMType, unknown)
 	}
@@ -118,6 +125,11 @@ func (l *LimaVzDriver) Validate() error {
 	if audioDevice != "" && audioDevice != "vz" {
 		logrus.Warnf("field `audio.device` must be %q for VZ driver , got %q", "vz", audioDevice)
 	}
+
+	videoDisplay := *l.Yaml.Video.Display
+	if videoDisplay != "" && videoDisplay != "vz" {
+		logrus.Warnf("field `video.display` must be %q for VZ driver , got %q", "vz", videoDisplay)
+	}
 	return nil
 }
 
@@ -129,18 +141,23 @@ func (l *LimaVzDriver) CreateDisk() error {
 	return nil
 }
 
-func (l *LimaVzDriver) Start(ctx context.Context) (chan error, error) {
+func (l *LimaVzDriver) Start(ctx context.Context) (bool, chan error, error) {
 	logrus.Infof("Starting VZ (hint: to watch the boot progress, see %q)", filepath.Join(l.Instance.Dir, filenames.SerialLog))
 	vm, errCh, err := startVM(ctx, l.BaseDriver)
 	if err != nil {
 		if errors.Is(err, vz.ErrUnsupportedOSVersion) {
-			return nil, fmt.Errorf("vz driver requires macOS 13 or higher to run: %q", err)
+			return false, nil, fmt.Errorf("vz driver requires macOS 13 or higher to run: %q", err)
 		}
-		return nil, err
+		return false, nil, err
 	}
 	l.machine = vm
 
-	return errCh, nil
+	startGui := *l.Yaml.Video.Display == "vz"
+	return startGui, errCh, nil
+}
+
+func (l *LimaVzDriver) StartGUI() error {
+	return l.machine.StartGraphicApplication(1920, 1200)
 }
 
 func (l *LimaVzDriver) Stop(_ context.Context) error {
diff --git a/pkg/vz/vz_driver_others.go b/pkg/vz/vz_driver_others.go
@@ -32,8 +32,8 @@ func (l *LimaVzDriver) CreateDisk() error {
 	return ErrUnsupported
 }
 
-func (l *LimaVzDriver) Start(ctx context.Context) (chan error, error) {
-	return nil, ErrUnsupported
+func (l *LimaVzDriver) Start(ctx context.Context) (bool, chan error, error) {
+	return false, nil, ErrUnsupported
 }
 
 func (l *LimaVzDriver) Stop(_ context.Context) error {

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ func (l *LimaQemuDriver) CreateDisk() error {`
`58`	`58`	`return nil`
`59`	`59`	`}`
`60`	`60`
`61`		`-func (l *LimaQemuDriver) Start(ctx context.Context) (chan error, error) {`
	`61`	`+func (l *LimaQemuDriver) Start(ctx context.Context) (bool, chan error, error) {`
`62`	`62`	`qCfg := Config{`
`63`	`63`	`Name: l.Instance.Name,`
`64`	`64`	`InstanceDir: l.Instance.Dir,`
`@@ -67,35 +67,35 @@ func (l *LimaQemuDriver) Start(ctx context.Context) (chan error, error) {`
`67`	`67`	`}`
`68`	`68`	`qExe, qArgs, err := Cmdline(qCfg)`
`69`	`69`	`if err != nil {`
`70`		`- return nil, err`
	`70`	`+ return false, nil, err`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`var qArgsFinal []string`
`74`	`74`	`applier := &qArgTemplateApplier{}`
`75`	`75`	`for _, unapplied := range qArgs {`
`76`	`76`	`applied, err := applier.applyTemplate(unapplied)`
`77`	`77`	`if err != nil {`
`78`		`- return nil, err`
	`78`	`+ return false, nil, err`
`79`	`79`	`}`
`80`	`80`	`qArgsFinal = append(qArgsFinal, applied)`
`81`	`81`	`}`
`82`	`82`	`qCmd := exec.CommandContext(ctx, qExe, qArgsFinal...)`
`83`	`83`	`qCmd.ExtraFiles = append(qCmd.ExtraFiles, applier.files...)`
`84`	`84`	`qStdout, err := qCmd.StdoutPipe()`
`85`	`85`	`if err != nil {`
`86`		`- return nil, err`
	`86`	`+ return false, nil, err`
`87`	`87`	`}`
`88`	`88`	`go logPipeRoutine(qStdout, "qemu[stdout]")`
`89`	`89`	`qStderr, err := qCmd.StderrPipe()`
`90`	`90`	`if err != nil {`
`91`		`- return nil, err`
	`91`	`+ return false, nil, err`
`92`	`92`	`}`
`93`	`93`	`go logPipeRoutine(qStderr, "qemu[stderr]")`
`94`	`94`
`95`	`95`	`logrus.Infof("Starting QEMU (hint: to watch the boot progress, see %q)", filepath.Join(qCfg.InstanceDir, filenames.SerialLog))`
`96`	`96`	`logrus.Debugf("qCmd.Args: %v", qCmd.Args)`
`97`	`97`	`if err := qCmd.Start(); err != nil {`
`98`		`- return nil, err`
	`98`	`+ return false, nil, err`
`99`	`99`	`}`
`100`	`100`	`l.qCmd = qCmd`
`101`	`101`	`l.qWaitCh = make(chan error)`
`@@ -108,7 +108,7 @@ func (l *LimaQemuDriver) Start(ctx context.Context) (chan error, error) {`
`108`	`108`	`err = client.ResolveAndForwardSSH(limayaml.MACAddress(l.Instance.Dir), l.SSHLocalPort)`
`109`	`109`	`}`
`110`	`110`	`}()`
`111`		`- return l.qWaitCh, nil`
	`111`	`+ return false, l.qWaitCh, nil`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`func (l *LimaQemuDriver) Stop(ctx context.Context) error {`
Original file line number	Diff line number	Diff line change
`@@ -499,7 +499,7 @@ func attachDisks(driver driver.BaseDriver, vmConfig vz.VirtualMachineConfigura`
`499`	`499`	`}`
`500`	`500`
`501`	`501`	`func attachDisplay(driver driver.BaseDriver, vmConfig vz.VirtualMachineConfiguration) error {`
`502`		`- if driver.Yaml.Video.Display != nil {`
	`502`	`+ if *driver.Yaml.Video.Display == "vz" {`
`503`	`503`	`graphicsDeviceConfiguration, err := vz.NewVirtioGraphicsDeviceConfiguration()`
`504`	`504`	`if err != nil {`
`505`	`505`	`return err`
Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,8 @@ func (l *LimaVzDriver) CreateDisk() error {`
`32`	`32`	`return ErrUnsupported`
`33`	`33`	`}`
`34`	`34`
`35`		`-func (l *LimaVzDriver) Start(ctx context.Context) (chan error, error) {`
`36`		`- return nil, ErrUnsupported`
	`35`	`+func (l *LimaVzDriver) Start(ctx context.Context) (bool, chan error, error) {`
	`36`	`+ return false, nil, ErrUnsupported`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`func (l *LimaVzDriver) Stop(_ context.Context) error {`