github.com/jaypipes/ghw@v0.21.1/pkg/net/net_linux.go

// Use and distribution licensed under the Apache license version 2.
//
// See the COPYING file in the root project directory for full text.
//

package net

import (
	"bufio"
	"bytes"
	"fmt"
	"os"
	"os/exec"
	"path/filepath"
	"strings"

	"github.com/jaypipes/ghw/pkg/context"
	"github.com/jaypipes/ghw/pkg/linuxpath"
	"github.com/jaypipes/ghw/pkg/util"
)

const (
	warnEthtoolNotInstalled = `ethtool not installed. Cannot grab NIC capabilities`
)

func (i *Info) load() error {
	i.NICs = nics(i.ctx)
	return nil
}

func nics(ctx *context.Context) []*NIC {
	nics := make([]*NIC, 0)

	paths := linuxpath.New(ctx)
	files, err := os.ReadDir(paths.SysClassNet)
	if err != nil {
		return nics
	}

	etAvailable := ctx.EnableTools
	if etAvailable {
		if etInstalled := ethtoolInstalled(); !etInstalled {
			ctx.Warn(warnEthtoolNotInstalled)
			etAvailable = false
		}
	}

	for _, file := range files {
		filename := file.Name()
		// Ignore loopback and bonding_masters
		if filename == "lo" || filename == "bonding_masters" {
			continue
		}

		netPath := filepath.Join(paths.SysClassNet, filename)
		dest, _ := os.Readlink(netPath)
		isVirtual := false
		if strings.Contains(dest, "devices/virtual/net") {
			isVirtual = true
		}

		nic := &NIC{
			Name:      filename,
			IsVirtual: isVirtual,
		}

		mac := netDeviceMacAddress(paths, filename)
		nic.MacAddress = mac
		nic.MACAddress = mac
		if etAvailable {
			nic.netDeviceParseEthtool(ctx, filename)
		} else {
			nic.Capabilities = []*NICCapability{}
			// Sets NIC struct fields from data in SysFs
			nic.setNicAttrSysFs(paths, filename)
		}

		nic.PCIAddress = netDevicePCIAddress(paths.SysClassNet, filename)

		nics = append(nics, nic)
	}
	return nics
}

func netDeviceMacAddress(paths *linuxpath.Paths, dev string) string {
	// Instead of use udevadm, we can get the device's MAC address by examing
	// the /sys/class/net/$DEVICE/address file in sysfs. However, for devices
	// that have addr_assign_type != 0, return None since the MAC address is
	// random.
	aatPath := filepath.Join(paths.SysClassNet, dev, "addr_assign_type")
	contents, err := os.ReadFile(aatPath)
	if err != nil {
		return ""
	}
	if strings.TrimSpace(string(contents)) != "0" {
		return ""
	}
	addrPath := filepath.Join(paths.SysClassNet, dev, "address")
	contents, err = os.ReadFile(addrPath)
	if err != nil {
		return ""
	}
	return strings.TrimSpace(string(contents))
}

func ethtoolInstalled() bool {
	_, err := exec.LookPath("ethtool")
	return err == nil
}

func (n *NIC) netDeviceParseEthtool(ctx *context.Context, dev string) {
	var out bytes.Buffer
	path, _ := exec.LookPath("ethtool")

	// Get auto-negotiation and pause-frame-use capabilities from "ethtool" (with no options)
	// Populate Speed, Duplex, SupportedLinkModes, SupportedPorts, SupportedFECModes,
	// AdvertisedLinkModes, and AdvertisedFECModes attributes from "ethtool" output.
	cmd := exec.Command(path, dev)
	cmd.Stdout = &out
	err := cmd.Run()
	if err == nil {
		m := parseNicAttrEthtool(&out)
		n.Capabilities = append(n.Capabilities, autoNegCap(m))
		n.Capabilities = append(n.Capabilities, pauseFrameUseCap(m))

		// Update NIC Attributes with ethtool output
		n.Speed = strings.Join(m["Speed"], "")
		n.Duplex = strings.Join(m["Duplex"], "")
		n.SupportedLinkModes = m["Supported link modes"]
		n.SupportedPorts = m["Supported ports"]
		n.SupportedFECModes = m["Supported FEC modes"]
		n.AdvertisedLinkModes = m["Advertised link modes"]
		n.AdvertisedFECModes = m["Advertised FEC modes"]
	} else {
		msg := fmt.Sprintf("could not grab NIC link info for %s: %s", dev, err)
		ctx.Warn(msg)
	}

	// Get all other capabilities from "ethtool -k"
	cmd = exec.Command(path, "-k", dev)
	cmd.Stdout = &out
	err = cmd.Run()
	if err == nil {
		// The out variable will now contain something that looks like the
		// following.
		//
		// Features for enp58s0f1:
		// rx-checksumming: on
		// tx-checksumming: off
		//     tx-checksum-ipv4: off
		//     tx-checksum-ip-generic: off [fixed]
		//     tx-checksum-ipv6: off
		//     tx-checksum-fcoe-crc: off [fixed]
		//     tx-checksum-sctp: off [fixed]
		// scatter-gather: off
		//     tx-scatter-gather: off
		//     tx-scatter-gather-fraglist: off [fixed]
		// tcp-segmentation-offload: off
		//     tx-tcp-segmentation: off
		//     tx-tcp-ecn-segmentation: off [fixed]
		//     tx-tcp-mangleid-segmentation: off
		//     tx-tcp6-segmentation: off
		// < snipped >
		scanner := bufio.NewScanner(&out)
		// Skip the first line...
		scanner.Scan()
		for scanner.Scan() {
			line := strings.TrimPrefix(scanner.Text(), "\t")
			n.Capabilities = append(n.Capabilities, netParseEthtoolFeature(line))
		}

	} else {
		msg := fmt.Sprintf("could not grab NIC capabilities for %s: %s", dev, err)
		ctx.Warn(msg)
	}

}

// netParseEthtoolFeature parses a line from the ethtool -k output and returns
// a NICCapability.
//
// The supplied line will look like the following:
//
// tx-checksum-ip-generic: off [fixed]
//
// [fixed] indicates that the feature may not be turned on/off. Note: it makes
// no difference whether a privileged user runs `ethtool -k` when determining
// whether [fixed] appears for a feature.
func netParseEthtoolFeature(line string) *NICCapability {
	parts := strings.Fields(line)
	cap := strings.TrimSuffix(parts[0], ":")
	enabled := parts[1] == "on"
	fixed := len(parts) == 3 && parts[2] == "[fixed]"
	return &NICCapability{
		Name:      cap,
		IsEnabled: enabled,
		CanEnable: !fixed,
	}
}

func netDevicePCIAddress(netDevDir, netDevName string) *string {
	// what we do here is not that hard in the end: we need to navigate the sysfs
	// up to the directory belonging to the device backing the network interface.
	// we can make few relatively safe assumptions, but the safest way is follow
	// the right links. And so we go.
	// First of all, knowing the network device name we need to resolve the backing
	// device path to its full sysfs path.
	// say we start with netDevDir="/sys/class/net" and netDevName="enp0s31f6"
	netPath := filepath.Join(netDevDir, netDevName)
	dest, err := os.Readlink(netPath)
	if err != nil {
		// bail out with empty value
		return nil
	}
	// now we have something like dest="../../devices/pci0000:00/0000:00:1f.6/net/enp0s31f6"
	// remember the path is relative to netDevDir="/sys/class/net"

	netDev := filepath.Clean(filepath.Join(netDevDir, dest))
	// so we clean "/sys/class/net/../../devices/pci0000:00/0000:00:1f.6/net/enp0s31f6"
	// leading to "/sys/devices/pci0000:00/0000:00:1f.6/net/enp0s31f6"
	// still not there. We need to access the data of the pci device. So we jump into the path
	// linked to the "device" pseudofile
	dest, err = os.Readlink(filepath.Join(netDev, "device"))
	if err != nil {
		// bail out with empty value
		return nil
	}
	// we expect something like="../../../0000:00:1f.6"

	devPath := filepath.Clean(filepath.Join(netDev, dest))
	// so we clean "/sys/devices/pci0000:00/0000:00:1f.6/net/enp0s31f6/../../../0000:00:1f.6"
	// leading to "/sys/devices/pci0000:00/0000:00:1f.6/"
	// finally here!

	// to which bus is this device connected to?
	dest, err = os.Readlink(filepath.Join(devPath, "subsystem"))
	if err != nil {
		// bail out with empty value
		return nil
	}
	// ok, this is hacky, but since we need the last *two* path components and we know we
	// are running on linux...
	if !strings.HasSuffix(dest, "/bus/pci") {
		// unsupported and unexpected bus!
		return nil
	}

	pciAddr := filepath.Base(devPath)
	return &pciAddr
}

func (nic *NIC) setNicAttrSysFs(paths *linuxpath.Paths, dev string) {
	// Get speed and duplex from /sys/class/net/$DEVICE/ directory
	nic.Speed = readFile(filepath.Join(paths.SysClassNet, dev, "speed"))
	nic.Duplex = readFile(filepath.Join(paths.SysClassNet, dev, "duplex"))
}

func readFile(path string) string {
	contents, err := os.ReadFile(path)
	if err != nil {
		return ""
	}
	return strings.TrimSpace(string(contents))
}

func autoNegCap(m map[string][]string) *NICCapability {
	autoNegotiation := NICCapability{Name: "auto-negotiation", IsEnabled: false, CanEnable: false}

	an, anErr := util.ParseBool(strings.Join(m["Auto-negotiation"], ""))
	aan, aanErr := util.ParseBool(strings.Join(m["Advertised auto-negotiation"], ""))
	if an && aan && aanErr == nil && anErr == nil {
		autoNegotiation.IsEnabled = true
	}

	san, err := util.ParseBool(strings.Join(m["Supports auto-negotiation"], ""))
	if san && err == nil {
		autoNegotiation.CanEnable = true
	}

	return &autoNegotiation
}

func pauseFrameUseCap(m map[string][]string) *NICCapability {
	pauseFrameUse := NICCapability{Name: "pause-frame-use", IsEnabled: false, CanEnable: false}

	apfu, err := util.ParseBool(strings.Join(m["Advertised pause frame use"], ""))
	if apfu && err == nil {
		pauseFrameUse.IsEnabled = true
	}

	spfu, err := util.ParseBool(strings.Join(m["Supports pause frame use"], ""))
	if spfu && err == nil {
		pauseFrameUse.CanEnable = true
	}

	return &pauseFrameUse
}

func parseNicAttrEthtool(out *bytes.Buffer) map[string][]string {
	// The out variable will now contain something that looks like the
	// following.
	//
	//Settings for eth0:
	//	Supported ports: [ TP ]
	//	Supported link modes:   10baseT/Half 10baseT/Full
	//	                        100baseT/Half 100baseT/Full
	//	                        1000baseT/Full
	//	Supported pause frame use: No
	//	Supports auto-negotiation: Yes
	//	Supported FEC modes: Not reported
	//	Advertised link modes:  10baseT/Half 10baseT/Full
	//	                        100baseT/Half 100baseT/Full
	//	                        1000baseT/Full
	//	Advertised pause frame use: No
	//	Advertised auto-negotiation: Yes
	//	Advertised FEC modes: Not reported
	//	Speed: 1000Mb/s
	//	Duplex: Full
	//	Auto-negotiation: on
	//	Port: Twisted Pair
	//	PHYAD: 1
	//	Transceiver: internal
	//	MDI-X: off (auto)
	//	Supports Wake-on: pumbg
	//	Wake-on: d
	//        Current message level: 0x00000007 (7)
	//                               drv probe link
	//	Link detected: yes

	scanner := bufio.NewScanner(out)
	// Skip the first line
	scanner.Scan()
	m := make(map[string][]string)
	var name string
	for scanner.Scan() {
		var fields []string
		if strings.Contains(scanner.Text(), ":") {
			line := strings.Split(scanner.Text(), ":")
			name = strings.TrimSpace(line[0])
			str := strings.Trim(strings.TrimSpace(line[1]), "[]")
			switch str {
			case
				"Not reported",
				"Unknown":
				continue
			}
			fields = strings.Fields(str)
		} else {
			fields = strings.Fields(strings.Trim(strings.TrimSpace(scanner.Text()), "[]"))
		}

		for _, f := range fields {
			m[name] = append(m[name], strings.TrimSpace(f))
		}
	}

	return m
}