vde: allow vde URL with "vde://" prefix

It is called "URL" so we should support at least "vde://" prefix

Signed-off-by: Akihiro Suda <[email protected]>

Author: AkihiroSuda

docs/network.md

@@ -34,8 +34,8 @@ network:
   # daemons must be running before the instance is started. The interface type
   # (host, shared, or bridged) is configured in vde_vmnet and not lima.
   vde:
-    # url points to the vde_switch socket directory
-    - url: "/var/run/vde.ctl"
+    # url points to the vde_switch socket directory, optionally with vde:// prefix
+    - url: "vde:///var/run/vde.ctl"
       # MAC address of the instance; lima will pick one based on the instance name,
       # so DHCP assigned ip addresses should remain constant over instance restarts.
       macAddress: ""

examples/vmnet.yaml

@@ -20,4 +20,4 @@ network:
   # daemons must be running before the instance is started. The interface type
   # (host, shared, or bridged) is configured in vde_vmnet and not lima.
   vde:
-    - url: "/var/run/vde.ctl"
+    - url: "vde:///var/run/vde.ctl"

pkg/limayaml/default.yaml

@@ -125,8 +125,8 @@ network:
   # daemons must be running before the instance is started. The interface type
   # (host, shared, or bridged) is configured in vde_vmnet and not lima.
   vde:
-    # url points to the vde_switch socket directory
-    # - url: "/var/run/vde.ctl"
+    # url points to the vde_switch socket directory, optionally with vde:// prefix
+    # - url: "vde:///var/run/vde.ctl"
     #   # MAC address of the instance; lima will pick one based on the instance name,
     #   # so DHCP assigned ip addresses should remain constant over instance restarts.
     #   macAddress: ""

pkg/limayaml/validate.go

@@ -6,12 +6,14 @@ import (
 	"os"
 	"os/user"
 	"path/filepath"
+	"runtime"
 	"strings"
 
 	"github.com/AkihiroSuda/lima/pkg/localpathutil"
 	"github.com/AkihiroSuda/lima/pkg/qemu/qemuconst"
 	"github.com/docker/go-units"
 	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
 )
 
 func Validate(y LimaYAML) error {
@@ -176,21 +178,28 @@ func validateNetwork(yNetwork Network) error {
 			return errors.Errorf("field `%s.url` must not be empty", field)
 		}
 		// The field is called VDE.URL in anticipation of QEMU upgrading VDE2 to VDEplug4,
-		// but right now the only valid value is a path to the vde_switch socket directory.
-		fi, err := os.Stat(vde.URL)
-		if err != nil {
-			return errors.Wrapf(err, "field `%s.url` %q failed stat", field, vde.URL)
-		}
-		if !fi.IsDir() {
-			return errors.Wrapf(err, "field `%s.url` %q is not a directory", field, vde.URL)
-		}
-		ctlSocket := filepath.Join(vde.URL, "ctl")
-		fi, err = os.Stat(ctlSocket)
-		if err != nil {
-			return errors.Wrapf(err, "field `%s.url` control socket %q failed stat", field, ctlSocket)
-		}
-		if fi.Mode()&os.ModeSocket == 0 {
-			return errors.Errorf("field `%s.url` file %q is not a UNIX socket", field, ctlSocket)
+		// but right now the only valid value on macOS is a path to the vde_switch socket directory,
+		// optionally with vde:// prefix.
+		if !strings.Contains(vde.URL, "://") || strings.HasPrefix(vde.URL, "vde://") {
+			vdeSwitch := strings.TrimPrefix(vde.URL, "vde://")
+			fi, err := os.Stat(vdeSwitch)
+			if err != nil {
+				return errors.Wrapf(err, "field `%s.url` %q failed stat", field, vdeSwitch)
+			}
+			if !fi.IsDir() {
+				return errors.Wrapf(err, "field `%s.url` %q is not a directory", field, vdeSwitch)
+			}
+			ctlSocket := filepath.Join(vdeSwitch, "ctl")
+			fi, err = os.Stat(ctlSocket)
+			if err != nil {
+				return errors.Wrapf(err, "field `%s.url` control socket %q failed stat", field, ctlSocket)
+			}
+			if fi.Mode()&os.ModeSocket == 0 {
+				return errors.Errorf("field `%s.url` file %q is not a UNIX socket", field, ctlSocket)
+			}
+		} else if runtime.GOOS != "linux" {
+			logrus.Warnf("field `%s.url` is unlikely to work for %s (unless libvdeplug4 has been ported to %s and is installed)",
+				field, runtime.GOOS, runtime.GOOS)
 		}
 		if vde.MACAddress != "" {
 			hw, err := net.ParseMAC(vde.MACAddress)

pkg/qemu/qemu.go

@@ -197,7 +197,11 @@ func Cmdline(cfg Config) (string, []string, error) {
 	args = append(args, "-netdev", fmt.Sprintf("user,id=net0,net=192.168.5.0/24,hostfwd=tcp:127.0.0.1:%d-:22", y.SSH.LocalPort))
 	args = append(args, "-device", "virtio-net-pci,netdev=net0,mac="+limayaml.MACAddress(cfg.InstanceDir))
 	for i, vde := range y.Network.VDE {
-		args = append(args, "-netdev", fmt.Sprintf("vde,id=net%d,sock=%s", i+1, vde.URL))
+		// VDE4 accepts URL such as vde:///var/run/vde.ctl as well as file path such as /var/run/vde.ctl .
+		// VDE2 only accepts the latter form.
+		// VDE2 supports macOS but VDE4 does not yet, so we trim vde:// prefix here for VDE2 compatibility.
+		vdeSock := strings.TrimPrefix(vde.URL, "vde://")
+		args = append(args, "-netdev", fmt.Sprintf("vde,id=net%d,sock=%s", i+1, vdeSock))
 		args = append(args, "-device", fmt.Sprintf("virtio-net-pci,netdev=net%d,mac=%s", i+1, vde.MACAddress))
 	}