Support for querying disks based on LUN

Adds the Go wrappers on windows device query APIs to allow finding a disk device by the
provided LUN. This is mostly required inside the GCS where shim includes the LUN at which
a disk is attaches in the request and then the GCS needs to be able to find that disk to
use it further.

Signed-off-by: Amit Barve <[email protected]>
(cherry picked from commit ab0338a)
Signed-off-by: Kirtana Ashok <[email protected]>

Author: ambarve

internal/windevice/devicequery.go

@@ -3,17 +3,24 @@
 package windevice
 
 import (
+	"context"
 	"fmt"
 	"strings"
 	"unicode/utf16"
+	"unsafe"
 
 	"github.com/Microsoft/go-winio/pkg/guid"
+	"github.com/Microsoft/hcsshim/internal/log"
 	"github.com/Microsoft/hcsshim/internal/winapi"
 	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
+	"golang.org/x/sys/windows"
 )
 
 const (
-	_CM_GETIDLIST_FILTER_BUSRELATIONS uint32 = 0x00000020
+	_CM_GETIDLIST_FILTER_BUSRELATIONS         uint32 = 0x00000020
+	_CM_GET_DEVICE_INTERFACE_LIST_PRESENT     uint32 = 0x00000000
+	_CM_GET_DEVICE_INTERFACE_LIST_ALL_DEVICES uint32 = 0x00000001
 
 	_CM_LOCATE_DEVNODE_NORMAL uint32 = 0x00000000
 
@@ -24,6 +31,77 @@ const (
 	_DEVPKEY_LOCATIONPATHS_GUID = "a45c254e-df1c-4efd-8020-67d146a850e0"
 )
 
+var (
+	// class GUID for devices with interface type Disk
+	// 53f56307-b6bf-11d0-94f2-00a0c91efb8b
+	devClassDiskGUID = guid.GUID{
+		Data1: 0x53f56307,
+		Data2: 0xb6bf,
+		Data3: 0x11d0,
+		Data4: [8]byte{0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b},
+	}
+)
+
+// SCSI_ADDRESS structure used with IOCTL_SCSI_GET_ADDRESS.
+// defined here: https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/ntddscsi/ns-ntddscsi-_scsi_address
+type SCSIAddress struct {
+	Length     uint32
+	PortNumber uint8
+	PathId     uint8
+	TargetId   uint8
+	Lun        uint8
+}
+
+// STORAGE_DEVICE_NUMBER structure used with IOCTL_STORAGE_GET_DEVICE_NUMBER
+// https://learn.microsoft.com/en-us/windows/win32/api/winioctl/ns-winioctl-storage_device_number
+type StorageDeviceNumber struct {
+	DeviceType      uint32
+	DeviceNumber    uint32
+	PartitionNumber uint32
+}
+
+// getScsiAddress retrieves the SCSI address from a given disk handle
+func getScsiAddress(ctx context.Context, handle windows.Handle) (*SCSIAddress, error) {
+	// Create a SCSI_ADDRESS structure to receive the address information
+	address := &SCSIAddress{}
+	address.Length = uint32(unsafe.Sizeof(SCSIAddress{}))
+
+	// Buffer for the returned data
+	var bytesReturned uint32
+
+	// Call DeviceIoControl with IOCTL_SCSI_GET_ADDRESS
+	err := windows.DeviceIoControl(
+		handle,
+		_IOCTL_SCSI_GET_ADDRESS,
+		nil, 0, // no input buffer
+		(*byte)(unsafe.Pointer(address)),
+		address.Length, &bytesReturned, nil)
+	if err != nil {
+		return nil, fmt.Errorf("DeviceIoControl failed with error: %w", err)
+	}
+	if bytesReturned <= 0 {
+		return nil, fmt.Errorf("DeviceIoControl returned %d bytes", bytesReturned)
+	}
+	return address, nil
+}
+
+func getStorageDeviceNumber(ctx context.Context, handle windows.Handle) (*StorageDeviceNumber, error) {
+	var bytesReturned uint32
+	var deviceNumber StorageDeviceNumber
+	if err := windows.DeviceIoControl(
+		handle,
+		_IOCTL_STORAGE_GET_DEVICE_NUMBER,
+		nil, 0, // No input buffer
+		(*byte)(unsafe.Pointer(&deviceNumber)),
+		uint32(unsafe.Sizeof(deviceNumber)),
+		&bytesReturned,
+		nil,
+	); err != nil {
+		return nil, fmt.Errorf("get device number ioctl failed: %w", err)
+	}
+	return &deviceNumber, nil
+}
+
 // getDevPKeyDeviceLocationPaths creates a DEVPROPKEY struct for the
 // DEVPKEY_Device_LocationPaths property as defined in devpkey.h
 func getDevPKeyDeviceLocationPaths() (*winapi.DevPropKey, error) {
@@ -121,3 +199,92 @@ func getDeviceIDList(pszFilter *byte, ulFlags uint32) ([]string, error) {
 
 	return winapi.ConvertStringSetToSlice(buf)
 }
+
+// A device interface class represents a conceptual functionality that any device in that
+// class should support or represent such as a particular I/O contract. There are several
+// predefined interface classes and each class is identified by its own unique GUID. A
+// single device can implement/support multiple interface classes and there can be
+// multiple devices in the system that implement/support a particular interface class. A
+// device that implements a particular interface class is referred to as a device
+// interface instance. (For further details see:
+// https://learn.microsoft.com/en-us/windows-hardware/drivers/install/overview-of-device-interface-classes).
+//
+// getDeviceInterfaceInstancesByClass retrieves a list of device interface instances for
+// all the devices that are currently attached to the system filtered by the given
+// interface class(`interfaceClassGUID`). By default this only returns the list of devices
+// that are currently attached to the system. If `includeNonAttached` is true, includes
+// the devices that the system has seen earlier but aren't currently attached.
+//
+// For further details see: https://learn.microsoft.com/en-us/windows/win32/api/cfgmgr32/nf-cfgmgr32-cm_get_device_interface_lista
+func getDeviceInterfaceInstancesByClass(ctx context.Context, interfaceClassGUID *guid.GUID, includeNonAttached bool) (_ []string, err error) {
+	log.G(ctx).WithFields(logrus.Fields{
+		"inteface class":     interfaceClassGUID,
+		"includeNonAttached": includeNonAttached,
+	}).Debugf("get device interface instances by class")
+
+	interfaceListSize := uint32(0)
+	ulFlags := _CM_GET_DEVICE_INTERFACE_LIST_PRESENT
+	if includeNonAttached {
+		ulFlags = _CM_GET_DEVICE_INTERFACE_LIST_ALL_DEVICES
+	}
+
+	if err := winapi.CMGetDeviceInterfaceListSize(&interfaceListSize, interfaceClassGUID, nil, ulFlags); err != nil {
+		return nil, fmt.Errorf("failed to get size of device interface list: %w", err)
+	}
+
+	log.G(ctx).WithField("interface list size", interfaceListSize).Trace("retrieved device interface list size")
+
+	buf := make([]uint16, interfaceListSize)
+	if err := winapi.CMGetDeviceInterfaceList(&devClassDiskGUID, nil, &buf[0], interfaceListSize, 0); err != nil {
+		return nil, fmt.Errorf("failed to get device interface list: %w", err)
+	}
+	return convertNullSeparatedUint16BufToStringSlice(buf), nil
+}
+
+// GetDevicePathAndNumberFromControllerLUN finds the storage device that has a matching
+// `controller` and `LUN` and returns a physical device number of that device. This device
+// number can then be used to make a path of that device and open handles to that device,
+// mount that disk etc.
+func GetDevicePathAndNumberFromControllerLUN(ctx context.Context, controller, LUN uint8) (string, uint32, error) {
+	interfacePaths, err := getDeviceInterfaceInstancesByClass(ctx, &devClassDiskGUID, false)
+	if err != nil {
+		return "", 0, fmt.Errorf("failed to get device interface instances: %w", err)
+	}
+
+	log.G(ctx).Debugf("disk device interface list: %+v", interfacePaths)
+
+	// go over each disk device interface and find out its LUN
+	for _, iPath := range interfacePaths {
+		utf16Path, err := windows.UTF16PtrFromString(iPath)
+		if err != nil {
+			return "", 0, fmt.Errorf("failed to convert interface path [%s] to utf16: %w", iPath, err)
+		}
+
+		handle, err := windows.CreateFile(utf16Path, windows.GENERIC_READ|windows.GENERIC_WRITE,
+			windows.FILE_SHARE_READ|windows.FILE_SHARE_WRITE,
+			nil, windows.OPEN_EXISTING, 0, 0)
+		if err != nil {
+			return "", 0, fmt.Errorf("failed to get handle to interface path [%s]: %w", iPath, err)
+		}
+		defer windows.Close(handle)
+
+		scsiAddr, err := getScsiAddress(ctx, handle)
+		if err != nil {
+			return "", 0, fmt.Errorf("failed to get SCSI address for interface path [%s]: %w", iPath, err)
+		}
+		log.G(ctx).WithFields(logrus.Fields{
+			"device interface path": iPath,
+			"scsi address":          scsiAddr,
+		}).Trace("scsi path from device interface path")
+
+		//TODO(ambarve): is comparing controller with port number the correct way?
+		if scsiAddr.Lun == LUN && scsiAddr.PortNumber == controller {
+			deviceNumber, err := getStorageDeviceNumber(ctx, handle)
+			if err != nil {
+				return "", 0, fmt.Errorf("failed to get physical device number: %w", err)
+			}
+			return iPath, deviceNumber.DeviceNumber, nil
+		}
+	}
+	return "", 0, fmt.Errorf("no device found with controller: %d & LUN:%d", controller, LUN)
+}

internal/windevice/devicequery_test.go

@@ -0,0 +1,63 @@
+//go:build windows
+
+package windevice
+
+import (
+	"context"
+	"path/filepath"
+	"testing"
+	"time"
+
+	"github.com/Microsoft/go-winio/vhd"
+)
+
+func TestDeviceInterfaceInstancesWithPnpUtil(t *testing.T) {
+	ctx := context.Background()
+	initialInterfacesList, err := getDeviceInterfaceInstancesByClass(ctx, &devClassDiskGUID, false)
+	if err != nil {
+		t.Fatalf("failed to get initial disk interfaces: %v", err)
+	}
+	t.Logf("initial interface list: %+v\n", initialInterfacesList)
+
+	// make a fake VHD and attach it.
+	tempDir := t.TempDir()
+	vhdxPath := filepath.Join(tempDir, "test.vhdx")
+	if err := vhd.CreateVhdx(vhdxPath, 1, 1); err != nil {
+		t.Fatalf("failed to create vhd: %s", err)
+	}
+	if err := vhd.AttachVhd(vhdxPath); err != nil {
+		t.Fatalf("failed to attach vhd: %s", err)
+	}
+	t.Cleanup(func() {
+		if err := vhd.DetachVhd(vhdxPath); err != nil {
+			t.Logf("failed to detach VHD during cleanup: %s\n", err)
+		}
+	})
+
+	interfaceListAfterVHDAttach, err := getDeviceInterfaceInstancesByClass(ctx, &devClassDiskGUID, false)
+	if err != nil {
+		t.Fatalf("failed to get initial disk interfaces: %v", err)
+	}
+	t.Logf("interface list after attaching VHD: %+v\n", interfaceListAfterVHDAttach)
+
+	if len(initialInterfacesList) != (len(interfaceListAfterVHDAttach) - 1) {
+		t.Fatalf("expected to find exactly 1 new interface in the returned interfaces list")
+	}
+
+	if err := vhd.DetachVhd(vhdxPath); err != nil {
+		t.Fatalf("failed to detach VHD: %s\n", err)
+	}
+
+	// Looks like a small time gap is required before we query for device interfaces again to get the updated list.
+	time.Sleep(2 * time.Second)
+
+	finalInterfaceList, err := getDeviceInterfaceInstancesByClass(ctx, &devClassDiskGUID, false)
+	if err != nil {
+		t.Fatalf("failed to get initial disk interfaces: %v", err)
+	}
+	t.Logf("interface list after detaching VHD: %+v\n", finalInterfaceList)
+
+	if len(initialInterfacesList) != len(finalInterfaceList) {
+		t.Fatalf("expected interface lists to have same length")
+	}
+}