WWID handling wip

Implements #111
Implements #112

Author: anatol

Diff for: docs/manpage.md

@@ -131,13 +131,15 @@ Some parts of booster boot functionality can be modified with kernel boot parame
 Device reference is a way to specify a device or partition in kernel parameters. It is labeled as `$deviceref` above.
 Device reference has one of the following values:
 
-* `/dev/XXX` path to specific device file, it can be either a path to real device/partition like `/dev/sda1`, `/dev/nvme0n1` or path to dm-mapper virtual device like
+ * `/dev/XXX` path to specific device file, it can be either a path to real device/partition like `/dev/sda1`, `/dev/nvme0n1` or path to dm-mapper virtual device like
    `/dev/mapper/root` or `/dev/vg_mesos/lv_mesos_containers`.
  * `UUID=$UUID` or `/dev/disk/by-uuid/$UUID` references device by its filesystem/LUKS UUID. See notes about UUID formatting rules below.
  * `LABEL=$LABEL` or `/dev/disk/by-label/$LABEL` references device by its filesystem/LUKS label.
  * `PARTUUID=$UUID` or `/dev/disk/by-partuuid/$UUID` references device by GPT partition UUID.
  * `PARTUUID=$UUID/PARTNROFF=$OFFSET` references device by $OFFSET from a GPT partition specified by $UUID e.g. `PARTUUID=fd59d06d-ffa8-473b-94f0-6584cb2b6665/PARTNROFF=2`.
  * `PARTLABEL=$LABEL` or `/dev/disk/by-partlabel/$LABEL` references device by GPT partition label.
+ * `HWPATH=$PATH` or `/dev/disk/by-path/$PATH` references device by determenistic hardware path e.g. `pci-0000:02:00.0-nvme-1-part2`.
+ * `WWID=$ID` or `/dev/disk/by-id/$ID` references device by its wwid e.g. `nvme-KXG6AZNV256G_TOSHIBA_40SA13GZF6B1-part3`
 
 ### UUID parameters
 Boot parameters such as `root=UUID=$UUID` and `rd.luks.uuid=$UUID` allow you to specify the block device by its UUID.

Diff for: init/blkinfo.go

@@ -34,11 +34,18 @@ func readBlkInfo(path string) (*blkInfo, error) {
 	probes := []probeFn{probeGpt, probeFat, probeMbr, probeLuks, probeExt4, probeBtrfs, probeXfs, probeF2fs, probeLvmPv, probeMdraid, probeSwap}
 	for _, fn := range probes {
 		blk := fn(r)
-		if blk != nil {
-			info("blkinfo for %s: type=%s UUID=%s LABEL=%s", path, blk.format, blk.uuid.toString(), blk.label)
-			blk.path = path
-			return blk, nil
+		if blk == nil {
+			continue
 		}
+
+		// the following code mimics https://github.com/systemd/systemd/blob/main/rules.d/60-persistent-storage.rules
+		// hwpath
+
+		// wwid
+
+		info("blkinfo for %s: type=%s UUID=%s LABEL=%s", path, blk.format, blk.uuid.toString(), blk.label)
+		blk.path = path
+		return blk, nil
 	}
 
 	return nil, errUnknownBlockType

Diff for: init/deviceref.go

@@ -19,6 +19,8 @@ const (
 	refGptLabel
 	refFsUUID
 	refFsLabel
+	refHwPath
+	refWwID
 )
 
 // The are many ways a user can specify root partition (using name, fs uuid, fs label, gpt attribute, ...).
@@ -112,7 +114,10 @@ func (d *deviceRef) dependsOnGpt() bool {
 	return d.format == refGptType ||
 		d.format == refGptUUID ||
 		d.format == refGptUUIDPartoff ||
-		d.format == refGptLabel
+		d.format == refGptLabel ||
+		// both hwpath and wwid might include the parent device reference + "-partNN" suffix
+		d.format == refHwPath ||
+		d.format == refWwID
 }
 
 // checks whether given partition table contains active EFI service partition
@@ -199,6 +204,22 @@ func parseDeviceRef(param string) (*deviceRef, error) {
 		label := strings.TrimPrefix(param, "/dev/disk/by-partlabel/")
 		return &deviceRef{refGptLabel, label}, nil
 	}
+	if strings.HasPrefix(param, "HWPATH=") {
+		path := strings.TrimPrefix(param, "HWPATH=")
+		return &deviceRef{refHwPath, path}, nil
+	}
+	if strings.HasPrefix(param, "/dev/disk/by-path/") {
+		path := strings.TrimPrefix(param, "/dev/disk/by-path/")
+		return &deviceRef{refHwPath, path}, nil
+	}
+	if strings.HasPrefix(param, "WWID=") {
+		id := strings.TrimPrefix(param, "WWID=")
+		return &deviceRef{refWwID, id}, nil
+	}
+	if strings.HasPrefix(param, "/dev/disk/by-id/") {
+		id := strings.TrimPrefix(param, "/dev/disk/by-id/")
+		return &deviceRef{refWwID, id}, nil
+	}
 	if strings.HasPrefix(param, "/dev/") {
 		return &deviceRef{refPath, param}, nil
 	}

Diff for: init/go.mod

@@ -22,6 +22,8 @@ require (
 	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
 )
 
+require github.com/anatol/smart.go v0.0.0-20220218195151-5ee9e8fa73f0
+
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/lestrrat-go/backoff/v2 v2.0.8 // indirect

Diff for: init/go.sum

@@ -11,13 +11,16 @@ github.com/anatol/devmapper.go v0.0.0-20211210164347-f67e20c4e7f7 h1:/7MxcPFdUY7
 github.com/anatol/devmapper.go v0.0.0-20211210164347-f67e20c4e7f7/go.mod h1:zrna3BRNXKHSyOiw0ynGV2ASklN+IQBl4A4J+mXghCY=
 github.com/anatol/luks.go v0.0.0-20211210165108-5d9a15b4f614 h1:6nOeQoay/QVdEippGzfI9TxBTqPXV2EEfsY4jOBHJLc=
 github.com/anatol/luks.go v0.0.0-20211210165108-5d9a15b4f614/go.mod h1:88QkZxTPcAlsKkZvVVTs8YMn2Avp5H5itbmFNjGusaY=
+github.com/anatol/smart.go v0.0.0-20220218195151-5ee9e8fa73f0 h1:rnURfQKi7StDt+WxNWW0LSHZp4sexCTwV+QOFEEZJjg=
+github.com/anatol/smart.go v0.0.0-20220218195151-5ee9e8fa73f0/go.mod h1:mPog5NmM5znyLbUO9WQPJ4xQdVtuHPptPavY0055POc=
 github.com/anatol/tang.go v0.0.0-20211208011427-4f66a321d8ef/go.mod h1:GZLaH5+MzHEIY9aJpo6NU4Gess1AbA2P9AFFQkG8B2M=
 github.com/anatol/tang.go v0.0.0-20211230003118-4e3b011304ee h1:3OVqAwN2dpmvc1Evern4TyGvoPLiPAwiUn7MG5NV0KY=
 github.com/anatol/tang.go v0.0.0-20211230003118-4e3b011304ee/go.mod h1:6sIiHp2IvVRl6LTFvGO1OGW2Rzjl64gg5UHL0Jir42c=
 github.com/anatol/uevent.go v1.0.1-0.20210811163347-3e166d38c549 h1:CPuCjtWK5UI9KQPDhylGHfZe7Pp8j58WK7i3wpLemA0=
 github.com/anatol/uevent.go v1.0.1-0.20210811163347-3e166d38c549/go.mod h1:yO7hm0VhhOujsh+j0nn8ExPhAqIJh50MZOcKetKhAPA=
-github.com/anatol/vmtest v0.0.0-20211004221854-3a36b6b86cc0 h1:1my48uvB1J9Gpe9Jl03rdyHY2U4j0uRGQ6zmeGAMFao=
 github.com/anatol/vmtest v0.0.0-20211004221854-3a36b6b86cc0/go.mod h1:JiDFhD1zjgMx9ONsHhhucGwMvCLrJMl/yu/l5qP4XFw=
+github.com/anatol/vmtest v0.0.0-20211215032353-afd7b1dd38ef h1:YQzm9r8/ArTsQ6C3/h+w4Dz5dfkYkQbK/3ETLWW2i7Q=
+github.com/anatol/vmtest v0.0.0-20211215032353-afd7b1dd38ef/go.mod h1:JiDFhD1zjgMx9ONsHhhucGwMvCLrJMl/yu/l5qP4XFw=
 github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
 github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=
 github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
@@ -209,6 +212,7 @@ golang.org/x/crypto v0.0.0-20201217014255-9d1352758620/go.mod h1:jdWPYTVW3xRLrWP
 golang.org/x/crypto v0.0.0-20211202192323-5770296d904e/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/crypto v0.0.0-20211209193657-4570a0811e8b/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/crypto v0.0.0-20211215153901-e495a2d5b3d3/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
+golang.org/x/crypto v0.0.0-20220131195533-30dcbda58838/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/crypto v0.0.0-20220214200702-86341886e292 h1:f+lwQ+GtmgoY+A2YaQxlSOnDjXcQ7ZRLWOHbC6HtRqE=
 golang.org/x/crypto v0.0.0-20220214200702-86341886e292/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
@@ -269,6 +273,7 @@ golang.org/x/sys v0.0.0-20211205182925-97ca703d548d/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20211209171907-798191bca915/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211210111614-af8b64212486/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220204135822-1c1b9b1eba6a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220209214540-3681064d5158 h1:rm+CHSpPEEW2IsXUib1ThaHIjuBVZjxNgSKmBLFfD4c=
 golang.org/x/sys v0.0.0-20220209214540-3681064d5158/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=

Diff for: init/hwpath.go

@@ -0,0 +1,157 @@
+package main
+
+import (
+	"bytes"
+	"fmt"
+	"os"
+	"path"
+	"regexp"
+	"strings"
+)
+
+func hwPath(device string) (string, error) {
+	p := ""
+	parent := device
+	for parent != "/" {
+		subsystem, err := sysfsSubsystem(parent)
+		if err != nil {
+			return "", err
+		}
+
+		sysname := path.Base(parent)
+
+		skipped := false
+		switch subsystem {
+		case "pci":
+			p = prependPath("pci-"+sysname, p)
+			parent, err = sysfsSkipSubsystem(parent, "pci")
+			if err != nil {
+				return "", err
+			}
+			skipped = true
+		case "scsi":
+			data, err := sysfsAttributeValue(parent, "uevent")
+			if err != nil {
+				return "", err
+			}
+			props := parseProperties(data)
+			if props["DEVTYPE"] != "scsi_device" {
+				break
+			}
+
+			var host, bus, target, lun int
+			num, err := fmt.Sscanf(sysname, "%d:%d:%d:%d", &host, &bus, &target, &lun)
+			if err != nil {
+				return "", err
+			}
+			if num != 4 {
+				break
+			}
+
+			ataRE, err := regexp.Compile(`^.*/ata\d+/`)
+			if err != nil {
+				return "", err
+			}
+			if ata := ataRE.FindString(parent); ata != "" {
+				base := path.Base(ata)
+				portNo, err := sysfsAttributeValue(ata+"/ata_port/"+base, "port_no")
+				if err != nil {
+					return "", err
+				}
+				if bus != 0 {
+					/* Devices behind port multiplier have a bus != 0 */
+					p = prependPath(fmt.Sprintf("ata-%s.%d.0", portNo, bus), p)
+				} else {
+					/* Master/slave are distinguished by target id */
+					p = prependPath(fmt.Sprintf("ata-%s.%d", portNo, target), p)
+				}
+			} else {
+				p = prependPath("scsi-"+sysname, p)
+			}
+		case "nvme":
+			nsid, err := sysfsAttributeValue(device, "nsid")
+			if err != nil {
+				return "", err
+			}
+			p = prependPath("nvme-"+nsid, p)
+			parent, err = sysfsSkipSubsystem(parent, "nvme")
+			if err != nil {
+				return "", err
+			}
+			skipped = true
+		case "usb":
+			port := sysname[strings.IndexByte(sysname, '-')+1:]
+			p = prependPath("usb-0:"+port, p)
+			parent, err = sysfsSkipSubsystem(parent, "usb")
+			if err != nil {
+				return "", err
+			}
+			skipped = true
+		}
+		if !skipped {
+			parent = path.Dir(parent)
+		}
+	}
+	return p, nil
+}
+
+func prependPath(prefix, hwPath string) string {
+	if hwPath != "" {
+		return prefix + "-" + hwPath
+	}
+	return prefix
+}
+
+func sysfsSkipSubsystem(p, subsystem string) (string, error) {
+	for p != "/" {
+		s, err := sysfsSubsystem(p)
+		if err != nil {
+			return "", err
+		}
+		if s != subsystem {
+			break
+		}
+		p = path.Dir(p)
+	}
+
+	return p, nil
+}
+
+func sysfsSubsystem(sysPath string) (string, error) {
+	l, err := os.Readlink(path.Join(sysPath, "subsystem"))
+	if os.IsNotExist(err) {
+		return "", nil
+	}
+	return path.Base(l), err
+}
+
+func sysfsAttributeValue(sysPath, attr string) (string, error) {
+	for sysPath != "/" {
+		data, err := os.ReadFile(path.Join(sysPath, attr))
+		sysPath = path.Dir(sysPath)
+		if os.IsNotExist(err) {
+			continue
+		}
+		if err != nil {
+			return "", err
+		}
+		return string(bytes.TrimSpace(data)), nil
+	}
+	return "", os.ErrNotExist
+}
+
+func sysfsSubsystems(sysPath string) (map[string]bool, error) {
+	result := make(map[string]bool)
+	for sysPath != "/" {
+		l, err := sysfsSubsystem(sysPath)
+		if err != nil {
+			return nil, err
+		}
+		sysPath = path.Dir(sysPath)
+		if l == "" {
+			continue
+		}
+		result[path.Base(l)] = true
+	}
+	return result, nil
+}

Diff for: init/hwpath_test.go

@@ -0,0 +1,66 @@
+package main
+
+import (
+	"os"
+	"regexp"
+	"sort"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+/*func TestHwPath(t *testing.T) {
+	check := func(input, expected string) {
+		output, err := hwPath(input)
+		require.NoError(t, err)
+		require.Equal(t, expected, output)
+	}
+
+	check("/sys/devices/pci0000:00/0000:00:17.0/ata3/host2/target2:0:0/2:0:0:0/block/sda", "pci-0000:00:17.0-ata-3.0") // or pci-0000:00:17.0-ata-3.0 ?
+	check("/sys/devices/pci0000:00/0000:00:1d.0/0000:02:00.0/nvme/nvme1/nvme1n1", "pci-0000:02:00.0-nvme-1")
+	check("/sys/devices/pci0000:00/0000:00:1b.0/0000:03:00.0/nvme/nvme0/nvme0n1", "pci-0000:03:00.0-nvme-1")
+}*/
+
+// Goes over host's block devices and verifies its hw path
+func TestHostHwPath(t *testing.T) {
+	ents, err := os.ReadDir("/sys/block")
+	require.NoError(t, err)
+	var generatedPaths []string
+	for _, e := range ents {
+		sysfs, err := sysfsPathForBlock(e.Name())
+		require.NoError(t, err)
+		path, err := hwPath(sysfs)
+		require.NoError(t, err)
+		if path == "" {
+			continue // the block has no hardware path
+		}
+		generatedPaths = append(generatedPaths, path)
+	}
+
+	ents, err = os.ReadDir("/dev/disk/by-path")
+	require.NoError(t, err)
+	var existedPaths []string
+
+	partitionRe, err := regexp.Compile(`-part\d+$`)
+	require.NoError(t, err)
+
+	compatAtaRe, err := regexp.Compile(`-ata-\d+$`)
+	require.NoError(t, err)
+
+	for _, e := range ents {
+		if partitionRe.MatchString(e.Name()) {
+			// ignore partitions
+			continue
+		}
+		if compatAtaRe.MatchString(e.Name()) {
+			// booster does not support compat ATA paths
+			continue
+		}
+
+		existedPaths = append(existedPaths, e.Name())
+	}
+
+	sort.Strings(existedPaths)
+	sort.Strings(generatedPaths)
+	require.Equal(t, existedPaths, generatedPaths)
+}

Diff for: init/main.go

@@ -87,6 +87,8 @@ func addTableNameForDevice(devPath string, tablePath string) {
 	devicesMutex.Unlock()
 }
 
+// waitForTableToProcess checks whether `dev` has a parent partition table (e.g. GPT table) and if yes
+// then waits till the parent device is completely processed.
 func waitForTableToProcess(dev string) {
 	devicesMutex.Lock()
 

Diff for: init/udev.go

@@ -144,7 +144,6 @@ func handleBlockDeviceUevent(ev *uevent.Uevent) error {
 			return nil
 		}
 		return handleMapperDeviceUevent(ev)
-
 	}
 
 	if ev.Action != "add" {

Diff for: init/util_test.go

@@ -7,6 +7,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/require"
+	"github.com/yookoala/realpath"
 	"golang.org/x/sys/unix"
 )
 
@@ -124,3 +125,7 @@ func TestFromUnicode16(t *testing.T) {
 	check([]byte{0x3f, 0x04, 0x40, 0x04, 0x38, 0x04, 0x32, 0x04, 0x35, 0x04, 0x42, 0x04, 0x0, 0x0, 0x0, 0x0}, binary.LittleEndian, "привет")
 	check([]byte{0x04, 0x3f, 0x04, 0x40, 0x04, 0x38, 0x04, 0x32, 0x04, 0x35, 0x04, 0x42, 0x0, 0x0}, binary.BigEndian, "привет")
 }
+
+func sysfsPathForBlock(dev string) (string, error) {
+	return realpath.Realpath("/sys/block/" + dev)
+}