vde: change "url" to "vnl" (Virtual Network Locator)

To follow the latest VDE nomenclature.

rd235/vdeplug4@0899842

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

Author: AkihiroSuda

docs/network.md

@@ -34,8 +34,9 @@ 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, optionally with vde:// prefix
-    - url: "vde:///var/run/vde.ctl"
+    # vnl (virtual network locator) points to the vde_switch socket directory,
+    # optionally with vde:// prefix
+    - vnl: "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: "vde:///var/run/vde.ctl"
+    - vnl: "vde:///var/run/vde.ctl"

pkg/limayaml/default.yaml

@@ -125,8 +125,9 @@ 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, optionally with vde:// prefix
-    # - url: "vde:///var/run/vde.ctl"
+    # vnl (virtual network locator) points to the vde_switch socket directory,
+    # optionally with vde:// prefix
+    # - vnl: "vde:///var/run/vde.ctl"
     #   # VDE Switch port number (not TCP/UDP port number). Set to 65535 for PTP mode.
     #   # Default: 0
     #   switchPort: 0

pkg/limayaml/limayaml.go

@@ -111,7 +111,9 @@ type Network struct {
 	VDE []VDE `yaml:"vde,omitempty"`
 }
 type VDE struct {
-	URL        string `yaml:"url,omitempty"`
+	// VNL is a Virtual Network Locator (https://github.com/rd235/vdeplug4/commit/089984200f447abb0e825eb45548b781ba1ebccd).
+	// On macOS, only VDE2-compatible form (optionally with vde:// prefix) is supported.
+	VNL        string `yaml:"vnl,omitempty"`
 	SwitchPort uint16 `yaml:"switchPort,omitempty"` // VDE Switch port, not TCP/UDP port
 	MACAddress string `yaml:"macAddress,omitempty"`
 	Name       string `yaml:"name,omitempty"`

pkg/limayaml/validate.go

@@ -174,43 +174,43 @@ func validateNetwork(yNetwork Network) error {
 	networkName := make(map[string]int)
 	for i, vde := range yNetwork.VDE {
 		field := fmt.Sprintf("network.vde[%d]", i)
-		if vde.URL == "" {
-			return errors.Errorf("field `%s.url` must not be empty", field)
+		if vde.VNL == "" {
+			return errors.Errorf("field `%s.vnl` must not be empty", field)
 		}
-		// The field is called VDE.URL in anticipation of QEMU upgrading VDE2 to VDEplug4,
+		// The field is called VDE.VNL in anticipation of QEMU upgrading VDE2 to VDEplug4,
 		// 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://")
+		if !strings.Contains(vde.VNL, "://") || strings.HasPrefix(vde.VNL, "vde://") {
+			vdeSwitch := strings.TrimPrefix(vde.VNL, "vde://")
 			fi, err := os.Stat(vdeSwitch)
 			if err != nil {
-				return errors.Wrapf(err, "field `%s.url` %q failed stat", field, vdeSwitch)
+				return errors.Wrapf(err, "field `%s.vnl` %q failed stat", field, vdeSwitch)
 			}
 			if fi.IsDir() {
 				/* Switch mode (vdeSwitch is dir, port != 65535) */
 				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)
+					return errors.Wrapf(err, "field `%s.vnl` 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)
+					return errors.Errorf("field `%s.vnl` file %q is not a UNIX socket", field, ctlSocket)
 				}
 				if vde.SwitchPort == 65535 {
-					return errors.Errorf("field `%s.url` points to a non-PTP switch, so the port number must not be 65535", field)
+					return errors.Errorf("field `%s.vnl` points to a non-PTP switch, so the port number must not be 65535", field)
 				}
 			} else {
 				/* PTP mode (vdeSwitch is socket, port == 65535) */
 				if fi.Mode()&os.ModeSocket == 0 {
-					return errors.Errorf("field `%s.url` %q is not a directory nor a UNIX socket", field, vdeSwitch)
+					return errors.Errorf("field `%s.vnl` %q is not a directory nor a UNIX socket", field, vdeSwitch)
 				}
 				if vde.SwitchPort != 65535 {
-					return errors.Errorf("field `%s.url` points to a PTP (switchless) socket %q, so the port number has to be 65535 (got %d)",
+					return errors.Errorf("field `%s.vnl` points to a PTP (switchless) socket %q, so the port number has to be 65535 (got %d)",
 						field, vdeSwitch, vde.SwitchPort)
 				}
 			}
 		} 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)",
+			logrus.Warnf("field `%s.vnl` is unlikely to work for %s (unless libvdeplug4 has been ported to %s and is installed)",
 				field, runtime.GOOS, runtime.GOOS)
 		}
 		if vde.MACAddress != "" {

pkg/qemu/qemu.go

@@ -197,10 +197,10 @@ 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 {
-		// VDE4 accepts URL such as vde:///var/run/vde.ctl as well as file path such as /var/run/vde.ctl .
+		// VDE4 accepts VNL like vde:///var/run/vde.ctl as well as file path like /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://")
+		vdeSock := strings.TrimPrefix(vde.VNL, "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))
 	}