Support for display with vz driver

Signed-off-by: Balaji Vijayakumar <[email protected]>

Author: balajiv113

cmd/limactl/hostagent.go

@@ -8,6 +8,7 @@ import (
 	"net/http"
 	"os"
 	"os/signal"
+	"runtime"
 	"strconv"
 
 	"github.com/gorilla/mux"
@@ -27,6 +28,7 @@ func newHostagentCommand() *cobra.Command {
 	}
 	hostagentCommand.Flags().StringP("pidfile", "p", "", "write pid to file")
 	hostagentCommand.Flags().String("socket", "", "hostagent socket")
+	hostagentCommand.Flags().Bool("run-gui", false, "run gui synchronously within hostagent")
 	hostagentCommand.Flags().String("nerdctl-archive", "", "local file path (not URL) of nerdctl-full-VERSION-linux-GOARCH.tar.gz")
 	return hostagentCommand
 }
@@ -55,6 +57,16 @@ func hostagentAction(cmd *cobra.Command, args []string) error {
 
 	instName := args[0]
 
+	runGUI, err := cmd.Flags().GetBool("run-gui")
+	if err != nil {
+		return err
+	}
+	if runGUI {
+		//Without this the call to vz.RunGUI fails. Adding it here, as this has to be called before the vz cgo loads.
+		runtime.LockOSThread()
+		defer runtime.UnlockOSThread()
+	}
+
 	sigintCh := make(chan os.Signal, 1)
 	signal.Notify(sigintCh, os.Interrupt)
 

pkg/driver/driver.go

@@ -8,13 +8,31 @@ import (
 	"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
 
+	// CreateDisk returns error if the current driver fails in creating disk
 	CreateDisk() error
 
+	// Start is used for booting the vm using driver instance
+	// It returns a chan error on successful boot
+	// The second argument may contain error occurred while starting driver
 	Start(_ context.Context) (chan error, error)
 
+	// CanRunGUI returns bool to indicate if the hostagent need to run GUI synchronously
+	CanRunGUI() bool
+
+	// RunGUI is for starting GUI synchronously by hostagent. This method should be wait and return only after vm terminates
+	// It returns error if there are any failures
+	RunGUI() error
+
+	// Stop will terminate the running vm instance.
+	// It returns error if there are any errors during Stop
 	Stop(_ context.Context) error
 
 	ChangeDisplayPassword(_ context.Context, password string) error
@@ -49,6 +67,14 @@ 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
 }

pkg/hostagent/hostagent.go

@@ -335,12 +335,24 @@ func (a *HostAgent) Run(ctx context.Context) error {
 		logrus.Infof("VNC Password: `%s`", vncpwdfile)
 	}
 
+	if a.driver.CanRunGUI() {
+		go func() {
+			err = a.startRoutinesAndWait(ctx, errCh)
+			if err != nil {
+				logrus.Error(err)
+			}
+		}()
+		return a.driver.RunGUI()
+	}
+	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 +363,6 @@ func (a *HostAgent) Run(ctx context.Context) error {
 		stRunning.Running = true
 		a.emitEvent(ctx, events.Event{Status: stRunning})
 	}()
-
 	for {
 		select {
 		case driverErr := <-errCh:

pkg/start/start.go

@@ -117,6 +117,9 @@ func Start(ctx context.Context, inst *store.Instance) error {
 		"hostagent",
 		"--pidfile", haPIDPath,
 		"--socket", haSockPath)
+	if limaDriver.CanRunGUI() {
+		args = append(args, "--run-gui")
+	}
 	if nerdctlArchiveCache != "" {
 		args = append(args, "--nerdctl-archive", nerdctlArchiveCache)
 	}

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

pkg/vz/vz_driver_darwin.go

@@ -72,6 +72,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 +119,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
 }
 
@@ -143,6 +149,17 @@ func (l *LimaVzDriver) Start(ctx context.Context) (chan error, error) {
 	return errCh, nil
 }
 
+func (l *LimaVzDriver) CanRunGUI() bool {
+	return *l.Yaml.Video.Display == "vz"
+}
+
+func (l *LimaVzDriver) RunGUI() error {
+	if l.CanRunGUI() {
+		return l.machine.StartGraphicApplication(1920, 1200)
+	}
+	return fmt.Errorf("RunGUI is not support for the given driver '%s' and diplay '%s'", "vz", *l.Yaml.Video.Display)
+}
+
 func (l *LimaVzDriver) Stop(_ context.Context) error {
 	logrus.Info("Shutting down VZ")
 	canStop := l.machine.CanRequestStop()