[WIP]: Create a Plugin System for Lima #3573

unsuman · 2025-05-23T16:09:16Z

Important

This PR is only for preview purposes and not meant to be merged. Later, the commits can be cherry-picked and raised as separate small PRs.

This PR creates a Plugin System for drivers which can be embedded in the main binary or built as separate binaries, which then communicate with the main binary using gRPC. This work is done as part of my GSoC '25 task.

AkihiroSuda · 2025-05-26T05:33:16Z

cmd/limactl/start.go

@@ -54,6 +56,9 @@ $ limactl create --set='.cpus = 2 | .memory = "2GiB"'
 To see the template list:
 $ limactl create --list-templates

+To see the drivers list:
+$ limactl create --list-drivers


The example currently just focuses on templates, not on drivers.

AkihiroSuda · 2025-05-26T05:33:54Z

cmd/limactl/disk.go

@@ -16,7 +16,7 @@ import (
 	"github.com/docker/go-units"
 	"github.com/lima-vm/go-qcow2reader"
 	"github.com/lima-vm/lima/pkg/nativeimgutil"
-	"github.com/lima-vm/lima/pkg/qemu/imgutil"
+	"github.com/lima-vm/lima/pkg/qemuimgutil"


Eventually this should follow:

Define the common interface for qemuimgutil and nativeimgutil #3518

Not an urgent topic though

AkihiroSuda · 2025-05-26T05:34:50Z

pkg/builtins/drivers.go

+// SPDX-FileCopyrightText: Copyright The Lima Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package builtins


builitins should be in cmd/limactl/main*.go

AkihiroSuda · 2025-05-26T05:35:04Z

pkg/builtins/drivers.go

+import (
+	// Import all built-in drivers to register them in the registry.
+	_ "github.com/lima-vm/lima/pkg/driver/qemu"
+	_ "github.com/lima-vm/lima/pkg/driver/vz"


should be in main_darwin.go

AkihiroSuda · 2025-05-26T05:35:15Z

pkg/builtins/drivers.go

+	// Import all built-in drivers to register them in the registry.
+	_ "github.com/lima-vm/lima/pkg/driver/qemu"
+	_ "github.com/lima-vm/lima/pkg/driver/vz"
+	_ "github.com/lima-vm/lima/pkg/driver/wsl2"


should be in main_windows.go

AkihiroSuda · 2025-05-26T05:36:31Z

pkg/driver/driver.go


-	DeleteSnapshot(_ context.Context, tag string) error
+// Snapshot defines operations for managing snapshots.
+type Snapshot interface {


This represents a manager of snapshots, not a snapshot itself.

So it should be named like SnapshotManager or Snapshotter?
The latter one might be confusing, as it conflicts with the terminology of containerd, though.

AkihiroSuda · 2025-05-26T05:38:35Z

pkg/driver/vz/vz_driver_darwin.go

+}
+
+func (l *LimaVzDriver) ListSnapshots(_ context.Context) (string, error) {
+	return "", errors.New("unimplemented")


The common ErrImplemented should be defined so that it can be compared with errors.Is

AkihiroSuda · 2025-05-26T05:39:06Z

pkg/driver/vz/vz_driver_others.go

@@ -0,0 +1,118 @@
+//go:build !darwin || no_vz


The package shouldn't be compiled at all on non-Darwin

Signed-off-by: Ansuman Sahoo <[email protected]>

…plugin related functions Signed-off-by: Ansuman Sahoo <[email protected]>

Signed-off-by: Ansuman Sahoo <[email protected]>

…rnal drivers Signed-off-by: Ansuman Sahoo <[email protected]>

…internal plugins Signed-off-by: Ansuman Sahoo <[email protected]>

Signed-off-by: Ansuman Sahoo <[email protected]>

…rface Signed-off-by: Ansuman Sahoo <[email protected]>

…ement common error Signed-off-by: Ansuman Sahoo <[email protected]>

Signed-off-by: Ansuman Sahoo <[email protected]>

AkihiroSuda · 2025-05-28T03:43:11Z

pkg/driver/external/proto/driver.proto

+
+message Empty {}
+
+message InstanceConfig {


Can we just pass the byte array of YAML (or JSON), so that we do not need to sync the YAML struct with this proto definition?

Sure we can do that!

Signed-off-by: Ansuman Sahoo <[email protected]>

AkihiroSuda · 2025-05-30T17:13:50Z

pkg/driver/external/driver.proto

+
+    rpc GetVSockPort(google.protobuf.Empty) returns (GetVSockPortResponse);
+    rpc GetVirtioPort(google.protobuf.Empty) returns (GetVirtioPortResponse);
+}


CanRunGUI, Name, GetVSockPort, and GetVirtioPort could be consolidated into a single Info() rpc call.

Not urgent.

@AkihiroSuda Should I also consolidate these functions in the driver.Driver interface, in order to maintain consistency?

…tion Signed-off-by: Ansuman Sahoo <[email protected]>

…call Signed-off-by: Ansuman Sahoo <[email protected]>

Signed-off-by: Ansuman Sahoo <[email protected]>

…function Signed-off-by: Ansuman Sahoo <[email protected]>

Signed-off-by: Ansuman Sahoo <[email protected]>

AkihiroSuda · 2025-06-04T05:41:59Z

pkg/driver/external/client/methods.go

+func (d *DriverClient) Initialize(ctx context.Context) error {
+	d.logger.Debug("Initializing driver instance")
+
+	connCtx, cancel := context.WithTimeout(ctx, 5*time.Second)


timeout should be specified in the caller

AkihiroSuda · 2025-06-04T05:42:21Z

pkg/driver/external/server/methods.go

+	for {
+		n, err := conn.Read(buf)
+		if err != nil {
+			if err == io.EOF {


errors.Is is more robust

…ocess Signed-off-by: Ansuman Sahoo <[email protected]>

Signed-off-by: Ansuman Sahoo <[email protected]>

…in SetConfig() Signed-off-by: Ansuman Sahoo <[email protected]>

AkihiroSuda added the gsoc/2025 Google Summer of Code 2025 label May 23, 2025

unsuman force-pushed the feature/driver-plugin-system branch from 77877e0 to 7a082d2 Compare May 25, 2025 11:21

AkihiroSuda reviewed May 26, 2025

View reviewed changes

unsuman force-pushed the feature/driver-plugin-system branch from 3f1de89 to e53a368 Compare May 26, 2025 13:34

unsuman added 16 commits May 27, 2025 15:24

driver(internal): use existing driver.Driver as plugin interface

68726ee

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(internal): registry init

ff8a943

Signed-off-by: Ansuman Sahoo <[email protected]>

refactor(BaseDriver): remove driver.BaseDriver from Lima level

0f4bf50

Signed-off-by: Ansuman Sahoo <[email protected]>

refactor(BaseDriver): remove driver.BaseDriver from driver(qemu) level

c01a36d

Signed-off-by: Ansuman Sahoo <[email protected]>

refactor(BaseDriver): remove driver.BaseDriver from driver(vz) level

a1f79d5

Signed-off-by: Ansuman Sahoo <[email protected]>

refactor(BaseDriver): remove driver.BaseDriver from driver(wsl2) level

bff7bdc

Signed-off-by: Ansuman Sahoo <[email protected]>

refactor(BaseDriver): make drivers implement the driver.Driver interface

7fbd83a

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(internal): divide the driver.Driver interface and define some …

0fa3176

…plugin related functions Signed-off-by: Ansuman Sahoo <[email protected]>

driver(internal): change lima to support internal drivers

70372ca

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(internal): add blank imports and make changes to Lima for inte…

4c16e49

…rnal drivers Signed-off-by: Ansuman Sahoo <[email protected]>

driver(internal): add register files and make drivers compatible for …

f79456a

…internal plugins Signed-off-by: Ansuman Sahoo <[email protected]>

driver(internal): list available built-in drivers

54f1866

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(internal): fix CI checks and lint errors

f020bd5

Signed-off-by: Ansuman Sahoo <[email protected]>

refactor(driver): move qemu,vz and wsl2 to pkg/driver

0f42995

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(internal): refactor Snapshot to SnapshotManager in driver inte…

38dcc7e

…rface Signed-off-by: Ansuman Sahoo <[email protected]>

driver(internal): compile vz on darwin, wsl2 on windows only and impl…

4630452

…ement common error Signed-off-by: Ansuman Sahoo <[email protected]>

unsuman force-pushed the feature/driver-plugin-system branch from e53a368 to 4630452 Compare May 27, 2025 10:28

unsuman added 2 commits May 27, 2025 16:12

refactor(driver): remove redundant builtins pkg

dac2cff

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): proto file init

9db1cf4

Signed-off-by: Ansuman Sahoo <[email protected]>

AkihiroSuda reviewed May 28, 2025

View reviewed changes

unsuman added 7 commits May 28, 2025 21:45

driver(external): external driver manager init

76e73f9

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): complete proto file for driver interface

b8558d0

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): finalise proto file and generate gRPC code

b91f166

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): implement server defination

6c1a5cf

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): implement the grpc client and server

28ce50c

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): remove error from the grpc response payload

d7ccaf8

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): add discovery of external drivers

ed4ecef

Signed-off-by: Ansuman Sahoo <[email protected]>

AkihiroSuda reviewed May 30, 2025

View reviewed changes

unsuman added 5 commits June 2, 2025 17:03

driver(internal): consolidate some functions to single GetInfo() func…

80bf1d9

…tion Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): consolidate some functions to single GetInfo() rpc …

13db654

…call Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): implement Start() & SetConfig() as server methods

6351822

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): complete client grpc implementation and one server …

ffa8b16

…function Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): tweak some external driver manager code

09e50ef

Signed-off-by: Ansuman Sahoo <[email protected]>

AkihiroSuda reviewed Jun 4, 2025

View reviewed changes

unsuman added 3 commits June 4, 2025 22:10

driver(external): complete external driver manager and registering pr…

35d47d6

…ocess Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): some tweaks around server and client code

fad8a71

Signed-off-by: Ansuman Sahoo <[email protected]>

driver(external): server logs to a file and fixed json marshal error …

2a82bf3

…in SetConfig() Signed-off-by: Ansuman Sahoo <[email protected]>

unsuman force-pushed the feature/driver-plugin-system branch from 605e45e to 2a82bf3 Compare June 5, 2025 17:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[WIP]: Create a Plugin System for Lima #3573

[WIP]: Create a Plugin System for Lima #3573

unsuman commented May 23, 2025 •

edited

Loading

Uh oh!

AkihiroSuda May 26, 2025

Uh oh!

AkihiroSuda May 26, 2025

Uh oh!

AkihiroSuda May 26, 2025

Uh oh!

AkihiroSuda May 26, 2025

Uh oh!

AkihiroSuda May 26, 2025

Uh oh!

AkihiroSuda May 26, 2025 •

edited

Loading

Uh oh!

AkihiroSuda May 26, 2025

Uh oh!

AkihiroSuda May 26, 2025

Uh oh!

AkihiroSuda May 28, 2025

Uh oh!

unsuman May 28, 2025

Uh oh!

AkihiroSuda May 30, 2025

Uh oh!

unsuman Jun 2, 2025 •

edited

Loading

Uh oh!

AkihiroSuda Jun 2, 2025

Uh oh!

AkihiroSuda Jun 4, 2025

Uh oh!

AkihiroSuda Jun 4, 2025

Uh oh!

Uh oh!


		message Empty {}

		message InstanceConfig {

[WIP]: Create a Plugin System for Lima #3573

Are you sure you want to change the base?

[WIP]: Create a Plugin System for Lima #3573

Conversation

unsuman commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AkihiroSuda May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

unsuman Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

unsuman commented May 23, 2025 •

edited

Loading

AkihiroSuda May 26, 2025 •

edited

Loading

unsuman Jun 2, 2025 •

edited

Loading