driver(build): update Makefile to build drivers as internal or external

unsuman · unsuman · commit c8b411323c70 · 2025-07-05T16:28:07.000+05:30
Signed-off-by: Ansuman Sahoo &lt;anshumansahoo500@gmail.com&gt;
diff --git a/Makefile b/Makefile
@@ -167,7 +167,7 @@ binaries: limactl helpers guestagents \
 ################################################################################
 # _output/bin
 .PHONY: limactl lima helpers
-limactl: _output/bin/limactl$(exe) lima
+limactl: _output/bin/limactl$(exe) external-drivers lima
 
 ### Listing Dependencies
 
@@ -241,18 +241,46 @@ endif
 # calls the native resolver library and not the simplistic version in the Go library.
 ENVS__output/bin/limactl$(exe) = CGO_ENABLED=1 GOOS="$(GOOS)" GOARCH="$(GOARCH)" CC="$(CC)"
 
+LIMACTL_DRIVER_TAGS :=
+ifneq (,$(findstring vz,$(EXTERNAL_DRIVERS)))
+LIMACTL_DRIVER_TAGS += external_vz
+endif
+ifneq (,$(findstring qemu,$(EXTERNAL_DRIVERS)))
+LIMACTL_DRIVER_TAGS += external_qemu
+endif
+ifneq (,$(findstring wsl2,$(EXTERNAL_DRIVERS)))
+LIMACTL_DRIVER_TAGS += external_wsl2
+endif
+
+GO_BUILDTAGS ?=
+GO_BUILDTAGS_LIMACTL := $(strip $(GO_BUILDTAGS) $(LIMACTL_DRIVER_TAGS))
+
 _output/bin/limactl$(exe): $(LIMACTL_DEPS) $$(call force_build,$$@)
-# If the previous cross-compilation was for GOOS=windows, limactl.exe might still be present.
 ifneq ($(GOOS),windows) #
 	@rm -rf _output/bin/limactl.exe
 else
 	@rm -rf _output/bin/limactl
 endif
-	$(ENVS_$@) $(GO_BUILD) -o $@ ./cmd/limactl
+	$(ENVS_$@) $(GO_BUILD) -tags '$(GO_BUILDTAGS_LIMACTL)' -o $@ ./cmd/limactl
 ifeq ($(GOOS),darwin)
 	codesign -f -v --entitlements vz.entitlements -s - $@
 endif
 
+DRIVER_INSTALL_DIR := _output/libexec/lima
+
+.PHONY: external-drivers
+external-drivers:
+ifneq ($(EXTERNAL_DRIVERS),)
+	@mkdir -p $(DRIVER_INSTALL_DIR)
+	@for drv in $(EXTERNAL_DRIVERS); do \
+		echo "Building $$drv as external"; \
+		$(GO_BUILD) -o $(DRIVER_INSTALL_DIR)/lima-driver-$$drv ./cmd/lima-driver-$$drv; \
+		if [ "$$drv" = "vz" ]; then \
+            codesign -f -v --entitlements vz.entitlements -s - $(DRIVER_INSTALL_DIR)/lima-driver-vz; \
+        fi; \
+	done
+endif
+
 LIMA_CMDS = $(sort lima lima$(bat)) # $(sort ...) deduplicates the list
 LIMA_DEPS = $(addprefix _output/bin/,$(LIMA_CMDS))
 lima: $(LIMA_DEPS)
diff --git a/cmd/lima-driver-qemu/main.go b/cmd/lima-driver-qemu/main.go
@@ -10,6 +10,5 @@ import (
 
 // To be used as an external driver for Lima.
 func main() {
-	driver := qemu.New()
-	server.Serve(driver)
+	server.Serve(qemu.New())
 }
diff --git a/cmd/lima-driver-vz/main.go b/cmd/lima-driver-vz/main.go
@@ -12,6 +12,5 @@ import (
 
 // To be used as an external driver for Lima.
 func main() {
-	driver := vz.New()
-	server.Serve(driver)
+	server.Serve(vz.New())
 }
diff --git a/cmd/lima-driver-wsl2/main.go b/cmd/lima-driver-wsl2/main.go
@@ -1,4 +1,4 @@
-//go:build windows && !no_wsl
+//go:build windows
 
 // SPDX-FileCopyrightText: Copyright The Lima Authors
 // SPDX-License-Identifier: Apache-2.0
@@ -12,6 +12,5 @@ import (
 
 // To be used as an external driver for Lima.
 func main() {
-	driver := wsl2.New()
-	server.Serve(driver)
+	server.Serve(wsl2.New())
 }
diff --git a/cmd/limactl/main.go b/cmd/limactl/main.go
@@ -17,7 +17,6 @@ import (
 
 	"github.com/lima-vm/lima/pkg/debugutil"
 	"github.com/lima-vm/lima/pkg/driver/external/server"
-	_ "github.com/lima-vm/lima/pkg/driver/qemu" // register qemu driver for all platforms
 	"github.com/lima-vm/lima/pkg/fsutil"
 	"github.com/lima-vm/lima/pkg/osutil"
 	"github.com/lima-vm/lima/pkg/store/dirnames"
diff --git a/cmd/limactl/main_darwin.go b/cmd/limactl/main_darwin.go
@@ -1,9 +1,9 @@
-//go:build darwin && !no_vz
+//go:build !external_vz
 
 // SPDX-FileCopyrightText: Copyright The Lima Authors
 // SPDX-License-Identifier: Apache-2.0
 
 package main
 
 // Import vz driver to register it in the registry on darwin.
-// import _ "github.com/lima-vm/lima/pkg/driver/vz"
+import _ "github.com/lima-vm/lima/pkg/driver/vz"
diff --git a/cmd/limactl/main_qemu.go b/cmd/limactl/main_qemu.go
@@ -0,0 +1,9 @@
+//go:build !external_qemu
+
+// SPDX-FileCopyrightText: Copyright The Lima Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package main
+
+// Import qemu driver to register it in the registry on all platforms.
+import _ "github.com/lima-vm/lima/pkg/driver/qemu"
diff --git a/cmd/limactl/main_windows.go b/cmd/limactl/main_windows.go
@@ -1,4 +1,4 @@
-//go:build windows && !no_wsl
+//go:build !external_wsl2
 
 // SPDX-FileCopyrightText: Copyright The Lima Authors
 // SPDX-License-Identifier: Apache-2.0
diff --git a/pkg/driver/qemu/register.go b/pkg/driver/qemu/register.go
@@ -1,3 +1,5 @@
+//go:build !external_qemu
+
 // SPDX-FileCopyrightText: Copyright The Lima Authors
 // SPDX-License-Identifier: Apache-2.0
 
diff --git a/pkg/driver/vz/register.go b/pkg/driver/vz/register.go
@@ -1,4 +1,4 @@
-//go:build darwin && !no_vz
+//go:build darwin && !external_vz
 
 // SPDX-FileCopyrightText: Copyright The Lima Authors
 // SPDX-License-Identifier: Apache-2.0
diff --git a/pkg/driver/wsl2/register.go b/pkg/driver/wsl2/register.go
@@ -1,4 +1,4 @@
-//go:build windows && !no_wsl
+//go:build windows && !external_wsl2
 
 // SPDX-FileCopyrightText: Copyright The Lima Authors
 // SPDX-License-Identifier: Apache-2.0
diff --git a/pkg/registry/registry.go b/pkg/registry/registry.go
@@ -70,7 +70,7 @@ func registerExternalDriver(name, path string) {
 	}
 
 	if _, exists := internalDrivers[name]; exists {
-		logrus.Warnf("Driver %q is already registered as an internal driver, skipping external registration", name)
+		logrus.Debugf("Driver %q is already registered as an internal driver, skipping external registration", name)
 		return
 	}
 
@@ -88,10 +88,10 @@ func discoverDrivers() error {
 	}
 	stdDriverDir := filepath.Join(prefix, "libexec", "lima")
 
-	logrus.Infof("Discovering drivers in %s", stdDriverDir)
+	logrus.Debugf("Discovering external drivers in %s", stdDriverDir)
 	if _, err := os.Stat(stdDriverDir); err == nil {
 		if err := discoverDriversInDir(stdDriverDir); err != nil {
-			logrus.Warnf("Error discovering drivers in %q: %v", stdDriverDir, err)
+			logrus.Warnf("Error discovering external drivers in %q: %v", stdDriverDir, err)
 		}
 	}
 
@@ -104,13 +104,13 @@ func discoverDrivers() error {
 
 			info, err := os.Stat(path)
 			if err != nil {
-				logrus.Warnf("Error accessing driver path %q: %v", path, err)
+				logrus.Warnf("Error accessing external driver path %q: %v", path, err)
 				continue
 			}
 
 			if info.IsDir() {
 				if err := discoverDriversInDir(path); err != nil {
-					logrus.Warnf("Error discovering drivers in %q: %v", path, err)
+					logrus.Warnf("Error discovering external drivers in %q: %v", path, err)
 				}
 			} else if isExecutable(info.Mode()) {
 				registerDriverFile(path)

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,5 @@ import (`
`10`	`10`
`11`	`11`	`// To be used as an external driver for Lima.`
`12`	`12`	`func main() {`
`13`		`- driver := qemu.New()`
`14`		`- server.Serve(driver)`
	`13`	`+ server.Serve(qemu.New())`
`15`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,5 @@ import (`
`12`	`12`
`13`	`13`	`// To be used as an external driver for Lima.`
`14`	`14`	`func main() {`
`15`		`- driver := vz.New()`
`16`		`- server.Serve(driver)`
	`15`	`+ server.Serve(vz.New())`
`17`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-//go:build windows && !no_wsl`
	`1`	`+//go:build !external_wsl2`
`2`	`2`
`3`	`3`	`// SPDX-FileCopyrightText: Copyright The Lima Authors`
`4`	`4`	`// SPDX-License-Identifier: Apache-2.0`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+//go:build !external_qemu`
	`2`	`+`
`1`	`3`	`// SPDX-FileCopyrightText: Copyright The Lima Authors`
`2`	`4`	`// SPDX-License-Identifier: Apache-2.0`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-//go:build darwin && !no_vz`
	`1`	`+//go:build darwin && !external_vz`
`2`	`2`
`3`	`3`	`// SPDX-FileCopyrightText: Copyright The Lima Authors`
`4`	`4`	`// SPDX-License-Identifier: Apache-2.0`