Merge pull request #1696 from AkihiroSuda/cli-video

`limactl (create|start|edit)`: add `--video=<bool>`

Author: AkihiroSuda

cmd/limactl/editflags/editflags.go

@@ -59,6 +59,9 @@ func registerEdit(cmd *cobra.Command, commentPrefix string) {
 	flags.Bool("rosetta", false, commentPrefix+"enable Rosetta (for vz instances)")
 
 	flags.String("set", "", commentPrefix+"modify the template inplace, using yq syntax")
+
+	// negative performance impact: https://gitlab.com/qemu-project/qemu/-/issues/334
+	flags.Bool("video", false, commentPrefix+"enable video output (has negative performance impact for QEMU)")
 }
 
 // RegisterCreate registers flags related to in-place YAML modification, for `limactl create`.
@@ -179,6 +182,18 @@ func YQExpressions(flags *flag.FlagSet) ([]string, error) {
 			},
 			true},
 		{"set", d("%s"), true},
+		{"video",
+			func(_ *flag.Flag) (string, error) {
+				b, err := flags.GetBool("video")
+				if err != nil {
+					return "", err
+				}
+				if b {
+					return ".video.display = \"default\"", nil
+				}
+				return ".video.display = \"none\"", nil
+			},
+			true},
 		{"arch", d(".arch = %q"), false},
 		{"containerd",
 			func(_ *flag.Flag) (string, error) {

docs/experimental.md

@@ -15,4 +15,5 @@ The following commands are experimental and subject to change:
 
 - `limactl (create|start|edit) --set=<YQ EXPRESSION>`
 - `limactl (create|start|edit) --network=<NETWORK>`
+- `limactl (create|start|edit) --video=<BOOL>`
 - `limactl snapshot *`

pkg/vz/vm_darwin.go

@@ -487,7 +487,8 @@ func attachDisks(driver *driver.BaseDriver, vmConfig *vz.VirtualMachineConfigura
 }
 
 func attachDisplay(driver *driver.BaseDriver, vmConfig *vz.VirtualMachineConfiguration) error {
-	if *driver.Yaml.Video.Display == "vz" {
+	switch *driver.Yaml.Video.Display {
+	case "vz", "default":
 		graphicsDeviceConfiguration, err := vz.NewVirtioGraphicsDeviceConfiguration()
 		if err != nil {
 			return err
@@ -501,8 +502,12 @@ func attachDisplay(driver *driver.BaseDriver, vmConfig *vz.VirtualMachineConfigu
 		vmConfig.SetGraphicsDevicesVirtualMachineConfiguration([]vz.GraphicsDeviceConfiguration{
 			graphicsDeviceConfiguration,
 		})
+		return nil
+	case "none":
+		return nil
+	default:
+		return fmt.Errorf("unexpected video display %q", *driver.Yaml.Video.Display)
 	}
-	return nil
 }
 
 func attachFolderMounts(driver *driver.BaseDriver, vmConfig *vz.VirtualMachineConfiguration) error {

pkg/vz/vz_driver_darwin.go

@@ -120,9 +120,10 @@ func (l *LimaVzDriver) Validate() error {
 		logrus.Warnf("field `audio.device` must be %q for VZ driver , got %q", "vz", audioDevice)
 	}
 
-	videoDisplay := *l.Yaml.Video.Display
-	if videoDisplay != "none" && videoDisplay != "vz" {
-		logrus.Warnf("field `video.display` must be %q for VZ driver , got %q", "vz", videoDisplay)
+	switch videoDisplay := *l.Yaml.Video.Display; videoDisplay {
+	case "vz", "default", "none":
+	default:
+		logrus.Warnf("field `video.display` must be \"vz\", \"default\", or \"none\" for VZ driver , got %q", videoDisplay)
 	}
 	return nil
 }
@@ -146,7 +147,12 @@ func (l *LimaVzDriver) Start(ctx context.Context) (chan error, error) {
 }
 
 func (l *LimaVzDriver) CanRunGUI() bool {
-	return *l.Yaml.Video.Display == "vz"
+	switch *l.Yaml.Video.Display {
+	case "vz", "default":
+		return true
+	default:
+		return false
+	}
 }
 
 func (l *LimaVzDriver) RunGUI() error {