autostart: Ensure instance is started/stopped by launchd or systemctl

If the instance isn’t launched by `launchd`, it won’t be stopped on log out.

This changes to use `launchctl` or `systemctl` to start/stop the instance if it’s registered to autostart.

## Affected sub commands:
- `limactl start`
- `limactl stop`
- `limactl restart`
- `limactl edit`
- `limactl shell`

## API changes

### `pkg/autostart`
- Introduced `AutoStartedIdentifier()`:
  - If not empty, it indicates whether the instance was started by `launchd` or `systemd`.
- Added `RequestStart()`:
  - Delegates the operation to `launchd` or `systemd`.
- Added `RequestStop()`:
  - Delegates the operation to `launchd` or `systemd`.

### `pkg/autostart/launchd`
- Added `AutoStartedServiceName()`:
  - Uses the XPC_SERVICE_NAME environment variable as the service name.
- Added `RequestStart()`:
  - Uses `launchctl enable service-target` to avoid failing `bootstrap`.
  - Uses `launchctl bootstrap domain-target plist-path`.
- Added `RequestStop()`:
  - Uses `launchctl bootout service-target` if the instance is launched by `launchd`.
- Added `--progress` to the `limactl` option in `io.lima-vm.autostart.INSTANCE.plist`:
  - Required to support `limactl start --progress`.

### `pkg/autostart/systemd`
- Added `AutoStartedServiceName()`:
  - Uses `CurrentUnitName()` by `github.com/coreos/go-systemd/v22/util` as the service identifier.
- Added `RequestStart()`:
  - Uses `systemctl --user start unit-name`.
- Added `RequestStop()`:
  - Uses `systemctl --user stop unit-name` if the instance is launched by `systemd`.
- Added `--progress` to the `limactl` option in `[email protected]`:
  - Required to support `limactl start --progress`.

### `pkg/hostagent`
- Add `AutoStartedIdentifier` to `Info`.
  - If not empty, it indicates whether the instance was started by `launchd` or `systemd`.

### `pkg/instance`
- `StartWithPaths()`:
  - Use `autostart.IsRegistered()` to check if the instance is registered to autostart.
  - If `launchHostAgentForeground` is true, ignore autostart registration.
  - If the instance is registered to autostart, use `autostart.RequestStart()` instead of launching HostAgent.
- `StopGracefully()`:
  - Use `autostart.RequestStop()`.
- `Restart()`, `RestartForcibly()`:
  - Use `autostart.IsRegistered()` to skip `networks.Reconcile()` if the instance is registered to autostart.

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

Author: norio-nomura

cmd/limactl/delete.go

@@ -49,7 +49,7 @@ func deleteAction(cmd *cobra.Command, args []string) error {
 		if err := instance.Delete(cmd.Context(), inst, force); err != nil {
 			return fmt.Errorf("failed to delete instance %q: %w", instName, err)
 		}
-		if registered, err := autostart.IsRegistered(ctx, inst); err != nil {
+		if registered, err := autostart.IsRegistered(ctx, inst); err != nil && !errors.Is(err, autostart.ErrNotSupported) {
 			logrus.WithError(err).Warnf("Failed to check if the autostart entry for instance %q is registered", instName)
 		} else if registered {
 			if err := autostart.UnregisterFromStartAtLogin(ctx, inst); err != nil {

cmd/limactl/edit.go

@@ -14,6 +14,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/lima-vm/lima/v2/cmd/limactl/editflags"
+	"github.com/lima-vm/lima/v2/pkg/autostart"
 	"github.com/lima-vm/lima/v2/pkg/driverutil"
 	"github.com/lima-vm/lima/v2/pkg/editutil"
 	"github.com/lima-vm/lima/v2/pkg/instance"
@@ -155,9 +156,14 @@ func editAction(cmd *cobra.Command, args []string) error {
 	if !startNow {
 		return nil
 	}
-	err = networks.Reconcile(ctx, inst.Name)
-	if err != nil {
-		return err
+	// Network reconciliation will be performed by the process launched by the autostart manager
+	if registered, err := autostart.IsRegistered(ctx, inst); err != nil && !errors.Is(err, autostart.ErrNotSupported) {
+		return fmt.Errorf("failed to check if the autostart entry for instance %q is registered: %w", inst.Name, err)
+	} else if !registered {
+		err = networks.Reconcile(ctx, inst.Name)
+		if err != nil {
+			return err
+		}
 	}
 
 	// store.Inspect() syncs values between inst.YAML and the store.

cmd/limactl/shell.go

@@ -20,6 +20,7 @@ import (
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 
+	"github.com/lima-vm/lima/v2/pkg/autostart"
 	"github.com/lima-vm/lima/v2/pkg/envutil"
 	"github.com/lima-vm/lima/v2/pkg/instance"
 	"github.com/lima-vm/lima/v2/pkg/ioutilx"
@@ -101,9 +102,14 @@ func shellAction(cmd *cobra.Command, args []string) error {
 			return nil
 		}
 
-		err = networks.Reconcile(ctx, inst.Name)
-		if err != nil {
-			return err
+		// Network reconciliation will be performed by the process launched by the autostart manager
+		if registered, err := autostart.IsRegistered(ctx, inst); err != nil && !errors.Is(err, autostart.ErrNotSupported) {
+			return fmt.Errorf("failed to check if the autostart entry for instance %q is registered: %w", inst.Name, err)
+		} else if !registered {
+			err = networks.Reconcile(ctx, inst.Name)
+			if err != nil {
+				return err
+			}
 		}
 
 		err = instance.Start(ctx, inst, false, false)

cmd/limactl/start.go

@@ -17,6 +17,7 @@ import (
 	"github.com/spf13/pflag"
 
 	"github.com/lima-vm/lima/v2/cmd/limactl/editflags"
+	"github.com/lima-vm/lima/v2/pkg/autostart"
 	"github.com/lima-vm/lima/v2/pkg/driverutil"
 	"github.com/lima-vm/lima/v2/pkg/editutil"
 	"github.com/lima-vm/lima/v2/pkg/instance"
@@ -580,9 +581,14 @@ func startAction(cmd *cobra.Command, args []string) error {
 		logrus.Warnf("expected status %q, got %q", limatype.StatusStopped, inst.Status)
 	}
 	ctx := cmd.Context()
-	err = networks.Reconcile(ctx, inst.Name)
-	if err != nil {
-		return err
+	// Network reconciliation will be performed by the process launched by the autostart manager
+	if registered, err := autostart.IsRegistered(ctx, inst); err != nil && !errors.Is(err, autostart.ErrNotSupported) {
+		return fmt.Errorf("failed to check if the autostart entry for instance %q is registered: %w", inst.Name, err)
+	} else if !registered {
+		err = networks.Reconcile(ctx, inst.Name)
+		if err != nil {
+			return err
+		}
 	}
 
 	launchHostAgentForeground := false

go.mod

@@ -15,6 +15,7 @@ require (
 	github.com/containerd/continuity v0.4.5
 	github.com/containers/gvisor-tap-vsock v0.8.7 // gomodjail:unconfined
 	github.com/coreos/go-semver v0.3.1
+	github.com/coreos/go-systemd/v22 v22.5.0
 	github.com/cpuguy83/go-md2man/v2 v2.0.7
 	github.com/digitalocean/go-qemu v0.0.0-20221209210016-f035778c97f7
 	github.com/diskfs/go-diskfs v1.7.0 // gomodjail:unconfined

go.sum

@@ -44,6 +44,8 @@ github.com/containers/gvisor-tap-vsock v0.8.7 h1:mFMMU5CIXO9sbtsgECc90loUHx15km3
 github.com/containers/gvisor-tap-vsock v0.8.7/go.mod h1:Rf2gm4Lpac0IZbg8wwQDh7UuKCxHmnxar0hEZ08OXY8=
 github.com/coreos/go-semver v0.3.1 h1:yi21YpKnrx1gt5R+la8n5WgS0kCrsPp33dmEyHReZr4=
 github.com/coreos/go-semver v0.3.1/go.mod h1:irMmmIw/7yzSRPWryHsK7EYSg09caPQL03VsM8rvUec=
+github.com/coreos/go-systemd/v22 v22.5.0 h1:RrqgGjYQKalulkV8NGVIfkXQf6YYmOyiJKk8iXXhfZs=
+github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
 github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
 github.com/cpuguy83/go-md2man/v2 v2.0.7 h1:zbFlGlXEAKlwXpmvle3d8Oe3YnkKIK4xSRTd3sHPnBo=
 github.com/cpuguy83/go-md2man/v2 v2.0.7/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
@@ -104,6 +106,7 @@ github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4=
 github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M=
 github.com/goccy/go-yaml v1.18.0 h1:8W7wMFS12Pcas7KU+VVkaiCng+kG8QiFeFwzFb+rwuw=
 github.com/goccy/go-yaml v1.18.0/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
+github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
 github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q=
 github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
 github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=

pkg/autostart/autostart.go

@@ -9,6 +9,7 @@ import (
 	"runtime"
 	"sync"
 
+	"github.com/lima-vm/lima/v2/pkg/autostart/systemd"
 	"github.com/lima-vm/lima/v2/pkg/limatype"
 )
 
@@ -27,20 +28,46 @@ func UnregisterFromStartAtLogin(ctx context.Context, inst *limatype.Instance) er
 	return manager().UnregisterFromStartAtLogin(ctx, inst)
 }
 
+// AutoStartedIdentifier returns the identifier if the current process was started by the autostart manager.
+func AutoStartedIdentifier() string {
+	return manager().AutoStartedIdentifier()
+}
+
+// RequestStart requests to start the instance by identifier.
+func RequestStart(ctx context.Context, inst *limatype.Instance) error {
+	return manager().RequestStart(ctx, inst)
+}
+
+// RequestStop requests to stop the instance by identifier.
+func RequestStop(ctx context.Context, inst *limatype.Instance) (bool, error) {
+	return manager().RequestStop(ctx, inst)
+}
+
 type autoStartManager interface {
 	// Registration
 	IsRegistered(ctx context.Context, inst *limatype.Instance) (bool, error)
 	RegisterToStartAtLogin(ctx context.Context, inst *limatype.Instance) error
 	UnregisterFromStartAtLogin(ctx context.Context, inst *limatype.Instance) error
+
+	// Status
+	AutoStartedIdentifier() string
+
+	// Operation
+	// RequestStart requests to start the instance by identifier.
+	RequestStart(ctx context.Context, inst *limatype.Instance) error
+	// RequestStop requests to stop the instance by identifier.
+	RequestStop(ctx context.Context, inst *limatype.Instance) (bool, error)
 }
 
 var manager = sync.OnceValue(func() autoStartManager {
 	switch runtime.GOOS {
 	case "darwin":
 		return Launchd
 	case "linux":
-		return Systemd
-	default:
-		return &notSupportedManager{}
+		if systemd.IsRunningSystemd() {
+			return Systemd
+		}
+		// TODO: support other init systems
 	}
+	return &notSupportedManager{}
 })

pkg/autostart/autostart_test.go

@@ -38,6 +38,7 @@ func TestRenderTemplate(t *testing.T) {
 		<string>start</string>
 		<string>default</string>
 		<string>--foreground</string>
+		<string>--progress</string>
 	</array>
 	<key>RunAtLoad</key>
 	<true/>
@@ -65,7 +66,7 @@ Description=Lima - Linux virtual machines, with a focus on running containers.
 Documentation=man:lima(1)
 
 [Service]
-ExecStart=/limactl start %i --foreground
+ExecStart=/limactl start %i --foreground --progress
 WorkingDirectory=%h
 Type=simple
 TimeoutSec=10

pkg/autostart/launchd/io.lima-vm.autostart.INSTANCE.plist

@@ -10,6 +10,7 @@
 		<string>start</string>
 		<string>{{ .Instance }}</string>
 		<string>--foreground</string>
+		<string>--progress</string>
 	</array>
 	<key>RunAtLoad</key>
 	<true/>

pkg/autostart/launchd/launchd.go

@@ -9,8 +9,11 @@ import (
 	"fmt"
 	"os"
 	"os/exec"
+	"sync"
 
 	"github.com/sirupsen/logrus"
+
+	"github.com/lima-vm/lima/v2/pkg/limatype"
 )
 
 //go:embed io.lima-vm.autostart.INSTANCE.plist
@@ -32,7 +35,7 @@ func EnableDisableService(ctx context.Context, enable bool, instName string) err
 	if !enable {
 		action = "disable"
 	}
-	return launchctl(ctx, action, fmt.Sprintf("gui/%d/%s", os.Getuid(), ServiceNameFrom(instName)))
+	return launchctl(ctx, action, serviceTarget(instName))
 }
 
 func launchctl(ctx context.Context, args ...string) error {
@@ -42,3 +45,44 @@ func launchctl(ctx context.Context, args ...string) error {
 	logrus.Debugf("running command: %v", cmd.Args)
 	return cmd.Run()
 }
+
+// AutoStartedServiceName returns the launchd service name if the instance is started by launchd.
+func AutoStartedServiceName() string {
+	// Assume the instance is started by launchd if XPC_SERVICE_NAME is set and not "0".
+	// To confirm it is actually started by launchd, it needs to use `launch_activate_socket`.
+	// But that requires actual socket activation setup in the plist file.
+	// So we just check XPC_SERVICE_NAME here.
+	if xpcServiceName := os.Getenv("XPC_SERVICE_NAME"); xpcServiceName != "0" {
+		return xpcServiceName
+	}
+	return ""
+}
+
+var domainTarget = sync.OnceValue(func() string {
+	return fmt.Sprintf("gui/%d", os.Getuid())
+})
+
+func serviceTarget(instName string) string {
+	return fmt.Sprintf("%s/%s", domainTarget(), ServiceNameFrom(instName))
+}
+
+func RequestStart(ctx context.Context, inst *limatype.Instance) error {
+	// If disabled, bootstrap will fail.
+	_ = EnableDisableService(ctx, true, inst.Name)
+	if err := launchctl(ctx, "bootstrap", domainTarget(), GetPlistPath(inst.Name)); err != nil {
+		return fmt.Errorf("failed to start the instance %q via launchctl: %w", inst.Name, err)
+	}
+	return nil
+}
+
+func RequestStop(ctx context.Context, inst *limatype.Instance) (bool, error) {
+	logrus.Debugf("AutoStartedIdentifier=%q, ServiceNameFrom=%q", inst.AutoStartedIdentifier, ServiceNameFrom(inst.Name))
+	if inst.AutoStartedIdentifier == ServiceNameFrom(inst.Name) {
+		logrus.Infof("Stopping the instance %q started by launchd", inst.Name)
+		if err := launchctl(ctx, "bootout", serviceTarget(inst.Name)); err != nil {
+			return false, fmt.Errorf("failed to stop the instance %q via launchctl: %w", inst.Name, err)
+		}
+		return true, nil
+	}
+	return false, nil
+}