limayaml: add a .suspendOnSigInt field to control whether to use suspend

default `false`

Signed-off-by: Norio Nomura <[email protected]>

Author: norio-nomura

pkg/limayaml/defaults.go

@@ -855,6 +855,32 @@ func FillDefault(y, d, o *LimaYAML, filePath string, warn bool) {
 		y.NestedVirtualization = ptr.Of(false)
 	}
 
+	if y.SuspendOnSigInt == nil {
+		y.SuspendOnSigInt = d.SuspendOnSigInt
+	}
+	if o.SuspendOnSigInt != nil {
+		y.SuspendOnSigInt = o.SuspendOnSigInt
+	}
+	if y.SuspendOnSigInt == nil {
+		y.SuspendOnSigInt = ptr.Of(false)
+	}
+	if *y.SuspendOnSigInt {
+		y.SuspendOnSigInt = ptr.Of(false)
+		if *y.VMType != VZ {
+			logrus.Warn("suspend is only supported for VM type vz")
+		} else if runtime.GOARCH != "arm64" {
+			logrus.Warn("suspend is only supported for arm64 VM type vz")
+		} else if runtime.GOOS != "darwin" {
+			logrus.Warn("suspend is only supported on macOS")
+		} else if macOSProductVersion, err := osutil.ProductVersion(); err != nil {
+			logrus.WithError(err).Warn("Failed to get macOS product version")
+		} else if macOSProductVersion.LessThan(*semver.New("14.0.0")) {
+			logrus.Warn("suspend is not supported on macOS prior to 14.0")
+		} else {
+			y.SuspendOnSigInt = ptr.Of(true)
+		}
+	}
+
 	if y.Plain == nil {
 		y.Plain = d.Plain
 	}
@@ -878,6 +904,7 @@ func fixUpForPlainMode(y *LimaYAML) {
 	y.Containerd.User = ptr.Of(false)
 	y.Rosetta.BinFmt = ptr.Of(false)
 	y.Rosetta.Enabled = ptr.Of(false)
+	y.SuspendOnSigInt = ptr.Of(false)
 	y.TimeZone = ptr.Of("")
 }
 

pkg/limayaml/defaults_test.go

@@ -112,6 +112,7 @@ func TestFillDefault(t *testing.T) {
 			RemoveDefaults: ptr.Of(false),
 		},
 		NestedVirtualization: ptr.Of(false),
+		SuspendOnSigInt:      ptr.Of(false),
 		Plain:                ptr.Of(false),
 		User: User{
 			Name:    ptr.Of(user.Username),
@@ -437,6 +438,7 @@ func TestFillDefault(t *testing.T) {
 			BinFmt:  ptr.Of(true),
 		},
 		NestedVirtualization: ptr.Of(true),
+		SuspendOnSigInt:      ptr.Of(true),
 		User: User{
 			Name:    ptr.Of("xxx"),
 			Comment: ptr.Of("Foo Bar"),
@@ -474,11 +476,13 @@ func TestFillDefault(t *testing.T) {
 			Enabled: ptr.Of(true),
 			BinFmt:  ptr.Of(true),
 		}
+		expect.SuspendOnSigInt = ptr.Of(true)
 	} else {
 		expect.Rosetta = Rosetta{
 			Enabled: ptr.Of(false),
 			BinFmt:  ptr.Of(true),
 		}
+		expect.SuspendOnSigInt = ptr.Of(false)
 	}
 	expect.Plain = ptr.Of(false)
 
@@ -660,6 +664,7 @@ func TestFillDefault(t *testing.T) {
 			BinFmt:  ptr.Of(false),
 		},
 		NestedVirtualization: ptr.Of(false),
+		SuspendOnSigInt:      ptr.Of(false),
 		User: User{
 			Name:    ptr.Of("foo"),
 			Comment: ptr.Of("foo bar baz"),
@@ -723,6 +728,7 @@ func TestFillDefault(t *testing.T) {
 	expect.Plain = ptr.Of(false)
 
 	expect.NestedVirtualization = ptr.Of(false)
+	expect.SuspendOnSigInt = ptr.Of(false)
 
 	FillDefault(&y, &d, &o, filePath, false)
 	assert.DeepEqual(t, &y, &expect, opts...)

pkg/limayaml/limayaml.go

@@ -48,6 +48,7 @@ type LimaYAML struct {
 	TimeZone             *string        `yaml:"timezone,omitempty" json:"timezone,omitempty" jsonschema:"nullable"`
 	NestedVirtualization *bool          `yaml:"nestedVirtualization,omitempty" json:"nestedVirtualization,omitempty" jsonschema:"nullable"`
 	User                 User           `yaml:"user,omitempty" json:"user,omitempty"`
+	SuspendOnSigInt      *bool          `yaml:"suspendOnSigInt,omitempty" json:"suspend,omitempty" jsonschema:"nullable"`
 }
 
 type (

pkg/store/instance.go

@@ -63,6 +63,7 @@ type Instance struct {
 	Protected       bool               `json:"protected"`
 	LimaVersion     string             `json:"limaVersion"`
 	Param           map[string]string  `json:"param,omitempty"`
+	SuspendOnSigInt bool               `json:"suspendOnSigInt"`
 }
 
 // Inspect returns err only when the instance does not exist (os.ErrNotExist).
@@ -179,6 +180,8 @@ func Inspect(instName string) (*Instance, error) {
 		inst.Errors = append(inst.Errors, err)
 	}
 	inst.Param = y.Param
+	// It might be changed by request from other limactl processes. So, copy it from the config.
+	inst.SuspendOnSigInt = *y.SuspendOnSigInt
 	return inst, nil
 }
 

pkg/vz/vz_driver_darwin.go

@@ -53,6 +53,7 @@ var knownYamlProperties = []string{
 	"PropagateProxyEnv",
 	"Provision",
 	"Rosetta",
+	"SuspendOnSigInt",
 	"SSH",
 	"TimeZone",
 	"UpgradePackages",
@@ -193,11 +194,13 @@ func (l *LimaVzDriver) RunGUI() error {
 }
 
 func (l *LimaVzDriver) Stop(_ context.Context) error {
-	machineStatePath := filepath.Join(l.Instance.Dir, filenames.VzMachineState)
-	if err := suspendVM(l.machine.VirtualMachine, machineStatePath); err != nil {
-		logrus.WithError(err).Warn("Failed to suspend VZ. Falling back to shutdown")
-	} else {
-		return nil
+	if l.Instance.SuspendOnSigInt {
+		machineStatePath := filepath.Join(l.Instance.Dir, filenames.VzMachineState)
+		if err := suspendVM(l.machine.VirtualMachine, machineStatePath); err != nil {
+			logrus.WithError(err).Warn("Failed to suspend VZ. Falling back to shutdown")
+		} else {
+			return nil
+		}
 	}
 
 	logrus.Info("Shutting down VZ")

templates/default.yaml

@@ -525,6 +525,11 @@ hostResolver:
 # 🟢 Builtin default: /usr/local
 guestInstallPrefix: null
 
+# When "suspendOnSigInt" is enabled, Lima suspends the VM instead of shutting it down.
+# The VM can be resumed with `limactl start` if the saved state is available.
+# 🟢 Builtin default: false
+suspendOnSigInt: null
+
 # When the "plain" mode is enabled:
 # - the YAML properties for mounts, port forwarding, containerd, etc. will be ignored
 # - guest agent will not be running