Merge pull request #285 from sunya-ch/hotfix-rename-host-device

fix: correct interface name on host-device ADD and prevent tabu prefix

Author: sunya-ch

cni/plugins/main/multi-nic/host-device.go

@@ -8,6 +8,8 @@ package main
 import (
 	"encoding/json"
 	"fmt"
+	"os"
+	"path/filepath"
 
 	"github.com/containernetworking/cni/pkg/types"
 	current "github.com/containernetworking/cni/pkg/types/100"
@@ -16,6 +18,7 @@ import (
 
 const (
 	HostDeviceIPAMType = "host-device-ipam"
+	sysBusPCI          = "/sys/bus/pci/devices"
 )
 
 type HostDeviceTypeNetConf struct {
@@ -70,7 +73,7 @@ func loadHostDeviceConf(bytes []byte, ifName string, n *NetConf, ipConfigs []*cu
 			return confBytesArray, err
 		}
 		if n.IPAM.Type == HostDeviceIPAMType {
-			ipConfig := getHostIPConfig(index, n.Masters[index])
+			ipConfig := getHostIPConfig(index, n.Masters[index], deviceID)
 			if ipConfig == nil {
 				utils.Logger.Debug(fmt.Sprintf("skip %d: no host IP", index))
 				confBytes = replaceEmptyIPAM(confBytes)
@@ -100,3 +103,30 @@ func copyHostDeviceConfig(original *HostDeviceNetConf) (*HostDeviceNetConf, erro
 	}
 	return copiedObject, nil
 }
+
+func getLinkNameFromPciAddress(pciaddr string) (string, error) {
+	netDir := filepath.Join(sysBusPCI, pciaddr, "net")
+	if _, err := os.Lstat(netDir); err != nil {
+		virtioNetDir := filepath.Join(sysBusPCI, pciaddr, "virtio*", "net")
+		matches, err := filepath.Glob(virtioNetDir)
+		if matches == nil || err != nil {
+			return "", fmt.Errorf("no net directory under pci device %s", pciaddr)
+		}
+		netDir = matches[0]
+	}
+	return linkNameFromPath(netDir)
+}
+
+// linkNameFromPath is modified from linkFromPath in HostDevice plugin CNI
+// https://github.com/containernetworking/plugins/blob/main/plugins/main/host-device/host-device.go#L499
+func linkNameFromPath(path string) (string, error) {
+	entries, err := os.ReadDir(path)
+	if err != nil {
+		return "", fmt.Errorf("failed to read directory %s: %q", path, err)
+	}
+	if len(entries) > 0 {
+		// grab the first net device
+		return entries[0].Name(), nil
+	}
+	return "", fmt.Errorf("failed to find network device in path %s", path)
+}

cni/plugins/main/multi-nic/utils.go

@@ -7,6 +7,9 @@ package main
 
 import (
 	"encoding/json"
+	"log"
+	"net"
+	"os/exec"
 	"strings"
 
 	"fmt"
@@ -85,11 +88,16 @@ func injectMaster(inData []byte, selectedNetAddrs []string, selectedMasters []st
 	return outBytes
 }
 
-// getHostIPConfig returns IP of host for a specific devName
-func getHostIPConfig(index int, devName string) *current.IPConfig {
-	devLink, err := netlink.LinkByName(devName)
+// getHostIPConfig returns IP of host for a specific device ID and correct devName if needed
+func getHostIPConfig(index int, devName, deviceID string) *current.IPConfig {
+	presentName, err := getLinkNameFromPciAddress(deviceID)
 	if err != nil {
-		utils.Logger.Debug(fmt.Sprintf("cannot find link %s: %v", devName, err))
+		utils.Logger.Debug(fmt.Sprintf("failed to get link name from device ID %s: %v", deviceID, err))
+		return nil
+	}
+	devLink, err := netlink.LinkByName(presentName)
+	if err != nil {
+		utils.Logger.Debug(fmt.Sprintf("cannot find link %s: %v", presentName, err))
 		return nil
 	}
 	addrs, err := netlink.AddrList(devLink, netlink.FAMILY_V4)
@@ -102,5 +110,41 @@ func getHostIPConfig(index int, devName string) *current.IPConfig {
 		Address:   *addr,
 		Interface: current.Int(index),
 	}
+	if devName != "" && presentName != devName {
+		if devLink.Attrs().Flags&net.FlagUp == net.FlagUp {
+			if err = netlink.LinkSetDown(devLink); err != nil {
+				log.Printf("WARNING: cannot set link down: %v", err)
+			}
+			defer func() {
+				_ = netlink.LinkSetUp(devLink)
+			}()
+		}
+		if err = netlink.LinkSetAlias(devLink, ""); err != nil {
+			log.Printf("WARNING: cannot reset alias: %v", err)
+		}
+
+		if err = delAltName(presentName, devName); err != nil {
+			log.Printf("WARNING: cannot del altname: %v", err)
+		} else {
+			log.Printf("successfully delete altname %s (%s)", devName, presentName)
+		}
+
+		// correct the device to the expected name
+		if err = netlink.LinkSetName(devLink, devName); err != nil {
+			utils.Logger.Debug(fmt.Sprintf("failed to rename host device %s to %s: %v", presentName, devName, err))
+		} else {
+			utils.Logger.Debug(fmt.Sprintf("successfully rename host device %s to %s", presentName, devName))
+		}
+	}
 	return ipConf
 }
+
+// delAltName
+// temporary solution, need upgrade to netlink 1.3.1 for using LinkDelAltName
+func delAltName(presentName, devName string) error {
+	cmd := exec.Command("ip", "link", "property", "del", "dev", presentName, "altname", devName)
+	if err := cmd.Run(); err != nil {
+		return err
+	}
+	return nil
+}

daemon/src/iface/iface.go

@@ -24,6 +24,10 @@ type InterfaceInfoType struct {
 	PciAddress    string `json:"pciAddress"`
 }
 
+const (
+	zombiePrefix = "net1"
+)
+
 var interfaceInfoCache = InitSafeCache()
 
 func GetInterfaceInfoCache() map[string]InterfaceInfoType {
@@ -121,9 +125,12 @@ func GetInterfaces() []InterfaceInfoType {
 	if err != nil {
 		log.Printf("cannot get default subnet: %v", err)
 	}
-
 	for _, netDevice := range netDevices {
 		devName := netDevice.Name
+		if strings.HasPrefix(devName, zombiePrefix) {
+			log.Printf("found zombie interface name %s, skip", devName)
+			continue
+		}
 		devLink, err := netlink.LinkByName(devName)
 		if err != nil {
 			log.Printf("cannot find link %s: %v", devName, err)