Merge pull request #1801 from balajiv113/ip-user-v2

Support for deterministic ip for user-v2 network

Author: AkihiroSuda

cmd/limactl/usernet.go

@@ -24,6 +24,7 @@ func newUsernetCommand() *cobra.Command {
 	hostagentCommand.Flags().String("listen", "", "listen on a Unix socket and receive Bess-compatible FDs as SCM_RIGHTS messages")
 	hostagentCommand.Flags().String("subnet", "192.168.5.0/24", "sets subnet value for the usernet network")
 	hostagentCommand.Flags().Int("mtu", 1500, "mtu")
+	hostagentCommand.Flags().StringToString("leases", nil, "pass default static leases for startup. Eg: '192.168.104.1=52:55:55:b3:bc:d9,192.168.104.2=5a:94:ef:e4:0c:df' ")
 	return hostagentCommand
 }
 
@@ -58,6 +59,11 @@ func usernetAction(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
+	leases, err := cmd.Flags().GetStringToString("leases")
+	if err != nil {
+		return err
+	}
+
 	mtu, err := cmd.Flags().GetInt("mtu")
 	if err != nil {
 		return err
@@ -68,10 +74,11 @@ func usernetAction(cmd *cobra.Command, _ []string) error {
 	os.RemoveAll(fdSocket)
 
 	return usernet.StartGVisorNetstack(cmd.Context(), &usernet.GVisorNetstackOpts{
-		MTU:        mtu,
-		Endpoint:   endpoint,
-		QemuSocket: qemuSocket,
-		FdSocket:   fdSocket,
-		Subnet:     subnet,
+		MTU:           mtu,
+		Endpoint:      endpoint,
+		QemuSocket:    qemuSocket,
+		FdSocket:      fdSocket,
+		Subnet:        subnet,
+		DefaultLeases: leases,
 	})
 }

pkg/networks/usernet/client.go

@@ -80,7 +80,7 @@ func (c *Client) ResolveIPAddress(vmMacAddr string) (string, error) {
 		case <-timeout:
 			return "", errors.New("usernet unable to resolve IP for SSH forwarding")
 		case <-ticker.C:
-			leases, err := c.leases()
+			leases, err := c.Leases()
 			if err != nil {
 				return "", err
 			}
@@ -94,7 +94,7 @@ func (c *Client) ResolveIPAddress(vmMacAddr string) (string, error) {
 	}
 }
 
-func (c *Client) leases() (map[string]string, error) {
+func (c *Client) Leases() (map[string]string, error) {
 	res, err := c.client.Get(fmt.Sprintf("%s%s", c.base, "/services/dhcp/leases"))
 	if err != nil {
 		return nil, err
@@ -111,6 +111,18 @@ func (c *Client) leases() (map[string]string, error) {
 	return leases, nil
 }
 
+func NewClientByName(nwName string) *Client {
+	endpointSock, err := Sock(nwName, EndpointSock)
+	if err != nil {
+		return nil
+	}
+	subnet, err := Subnet(nwName)
+	if err != nil {
+		return nil
+	}
+	return NewClient(endpointSock, subnet)
+}
+
 func NewClient(endpointSock string, subnet net.IP) *Client {
 	return create(endpointSock, subnet, "http://lima")
 }

pkg/networks/usernet/config.go

@@ -103,6 +103,20 @@ func DNSIP(subnet net.IP) string {
 	return cidr.Inc(cidr.Inc(cidr.Inc(subnet))).String()
 }
 
+// Leases returns a leases file based on network name.
+func Leases(name string) (string, error) {
+	dir, err := dirnames.LimaNetworksDir()
+	if err != nil {
+		return "", err
+	}
+	sockPath := filepath.Join(filepath.Join(dir, name), "leases.json")
+	if len(sockPath) >= osutil.UnixPathMax {
+		return "", fmt.Errorf("usernet leases path %q too long: must be less than UNIX_PATH_MAX=%d characters, but is %d",
+			sockPath, osutil.UnixPathMax, len(sockPath))
+	}
+	return sockPath, nil
+}
+
 func netmaskToCidr(baseIP net.IP, netMask net.IP) (net.IP, *net.IPNet, error) {
 	size, _ := net.IPMask(netMask.To4()).Size()
 	return net.ParseCIDR(fmt.Sprintf("%s/%d", baseIP.String(), size))

pkg/networks/usernet/recoincile.go

@@ -3,12 +3,14 @@ package usernet
 import (
 	"bytes"
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"os"
 	"os/exec"
 	"path"
 	"path/filepath"
+	"strings"
 	"time"
 
 	"github.com/lima-vm/lima/pkg/lockutil"
@@ -57,16 +59,25 @@ func Start(ctx context.Context, name string) error {
 			return err
 		}
 
+		leases, err := readLeases(name)
+		if err != nil {
+			return err
+		}
+
 		err = lockutil.WithDirLock(usernetDir, func() error {
 			self, err := os.Executable()
 			if err != nil {
 				return err
 			}
+			leasesString := mapToCliString(leases)
 			args := []string{"usernet", "-p", pidFile,
 				"-e", endpointSock,
 				"--listen-qemu", qemuSock,
 				"--listen", fdSock,
 				"--subnet", subnet.String()}
+			if leasesString != "" {
+				args = append(args, "--leases", leasesString)
+			}
 			cmd := exec.CommandContext(ctx, self, args...)
 
 			stdoutPath := filepath.Join(usernetDir, fmt.Sprintf("%s.%s.%s.log", "usernet", name, "stdout"))
@@ -119,6 +130,11 @@ func Stop(name string) error {
 	if pid != 0 {
 		logrus.Debugf("Stopping usernet daemon")
 
+		err = writeLeases(name)
+		if err != nil {
+			return err
+		}
+
 		var stdout, stderr bytes.Buffer
 		cmd := exec.Command("/usr/bin/pkill", "-F", pidFile)
 		cmd.Stdout = &stdout
@@ -145,3 +161,51 @@ func Stop(name string) error {
 	}
 	return nil
 }
+
+func mapToCliString(m map[string]string) string {
+	var strArr []string
+	for key, value := range m {
+		strArr = append(strArr, fmt.Sprintf("%s=%s", key, value))
+	}
+	return strings.Join(strArr, ",")
+}
+
+func readLeases(name string) (map[string]string, error) {
+	leasesFile, err := Leases(name)
+	if err != nil {
+		return nil, err
+	}
+	var leases map[string]string
+	if _, err := os.Stat(leasesFile); errors.Is(err, os.ErrNotExist) {
+		return leases, nil
+	}
+	file, err := os.Open(leasesFile)
+	if err != nil {
+		return nil, err
+	}
+	decoder := json.NewDecoder(file)
+	err = decoder.Decode(&leases)
+	return leases, err
+}
+
+func writeLeases(nwName string) error {
+	client := NewClientByName(nwName)
+	leases, err := client.Leases()
+	if err != nil {
+		return err
+	}
+	leasesFile, err := Leases(nwName)
+	if err != nil {
+		return err
+	}
+	file, err := os.Create(leasesFile)
+	if err != nil {
+		return err
+	}
+	encoder := json.NewEncoder(file)
+	err = encoder.Encode(leases)
+	if err != nil {
+		return err
+	}
+	return nil
+}

pkg/qemu/qemu_driver.go

@@ -190,7 +190,7 @@ func (l *LimaQemuDriver) Start(ctx context.Context) (chan error, error) {
 	l.vhostCmds = vhostCmds
 	go func() {
 		if usernetIndex := limayaml.FirstUsernetIndex(l.Yaml); usernetIndex != -1 {
-			client := newUsernetClient(l.Yaml.Networks[usernetIndex].Lima)
+			client := usernet.NewClientByName(l.Yaml.Networks[usernetIndex].Lima)
 			err := client.ConfigureDriver(l.BaseDriver)
 			if err != nil {
 				l.qWaitCh <- err
@@ -298,7 +298,7 @@ func (l *LimaQemuDriver) killVhosts() error {
 func (l *LimaQemuDriver) shutdownQEMU(ctx context.Context, timeout time.Duration, qCmd *exec.Cmd, qWaitCh <-chan error) error {
 	logrus.Info("Shutting down QEMU with ACPI")
 	if usernetIndex := limayaml.FirstUsernetIndex(l.Yaml); usernetIndex != -1 {
-		client := newUsernetClient(l.Yaml.Networks[usernetIndex].Lima)
+		client := usernet.NewClientByName(l.Yaml.Networks[usernetIndex].Lima)
 		err := client.UnExposeSSH(l.SSHLocalPort)
 		if err != nil {
 			logrus.Warnf("Failed to remove SSH binding for port %d", l.SSHLocalPort)
@@ -350,18 +350,6 @@ func (l *LimaQemuDriver) killQEMU(_ context.Context, _ time.Duration, qCmd *exec
 	return errors.Join(qWaitErr, l.killVhosts())
 }
 
-func newUsernetClient(nwName string) *usernet.Client {
-	endpointSock, err := usernet.Sock(nwName, usernet.EndpointSock)
-	if err != nil {
-		return nil
-	}
-	subnet, err := usernet.Subnet(nwName)
-	if err != nil {
-		return nil
-	}
-	return usernet.NewClient(endpointSock, subnet)
-}
-
 func logPipeRoutine(r io.Reader, header string) {
 	scanner := bufio.NewScanner(r)
 	for scanner.Scan() {

pkg/vz/vm_darwin.go

@@ -148,15 +148,7 @@ func startUsernet(ctx context.Context, driver *driver.BaseDriver) (*usernet.Clie
 		return usernet.NewClient(endpointSock, subnetIP), err
 	}
 	nwName := driver.Yaml.Networks[firstUsernetIndex].Lima
-	endpointSock, err := usernet.Sock(nwName, usernet.EndpointSock)
-	if err != nil {
-		return nil, err
-	}
-	subnetIP, err := usernet.Subnet(nwName)
-	if err != nil {
-		return nil, err
-	}
-	return usernet.NewClient(endpointSock, subnetIP), nil
+	return usernet.NewClientByName(nwName), nil
 }
 
 func createVM(driver *driver.BaseDriver) (*vz.VirtualMachine, error) {