From acd2212c6f710b5d7c93f85622499117b6700e3d Mon Sep 17 00:00:00 2001 From: Dani Louca Date: Tue, 3 Oct 2023 17:10:11 -0400 Subject: [PATCH 1/2] Fetch stats from folder mounted volumes Signed-off-by: Dani Louca --- disk/disk_windows.go | 188 +++++++++++++++++++++++++++++-------------- go.mod | 1 + go.sum | 2 + 3 files changed, 131 insertions(+), 60 deletions(-) diff --git a/disk/disk_windows.go b/disk/disk_windows.go index e17db3e5b..a85e8dc00 100644 --- a/disk/disk_windows.go +++ b/disk/disk_windows.go @@ -4,22 +4,31 @@ package disk import ( - "bytes" "context" "fmt" + "strings" "syscall" + "unicode/utf16" "unsafe" + "github.com/pkg/errors" "github.com/shirou/gopsutil/v3/internal/common" "golang.org/x/sys/windows" "golang.org/x/sys/windows/registry" ) +const volumeNameBufferLength = uint32(windows.MAX_PATH + 1) +const volumePathBufferLength = volumeNameBufferLength + var ( - procGetDiskFreeSpaceExW = common.Modkernel32.NewProc("GetDiskFreeSpaceExW") - procGetLogicalDriveStringsW = common.Modkernel32.NewProc("GetLogicalDriveStringsW") - procGetDriveType = common.Modkernel32.NewProc("GetDriveTypeW") - procGetVolumeInformation = common.Modkernel32.NewProc("GetVolumeInformationW") + procGetDiskFreeSpaceExW = common.Modkernel32.NewProc("GetDiskFreeSpaceExW") + procGetLogicalDriveStringW = common.Modkernel32.NewProc("GetLogicalDriveStringsW") + procGetDriveTypeW = common.Modkernel32.NewProc("GetDriveTypeW") + procGetVolumeInformationW = common.Modkernel32.NewProc("GetVolumeInformationW") + procFindFirstVolumeW = common.Modkernel32.NewProc("FindFirstVolumeW") + procFindNextVolumeW = common.Modkernel32.NewProc("FindNextVolumeW") + procFindVolumeClose = common.Modkernel32.NewProc("FindVolumeClose") + procGetVolumePathNamesForVolumeNameW = common.Modkernel32.NewProc("GetVolumePathNamesForVolumeNameW") ) var ( @@ -87,7 +96,7 @@ func PartitionsWithContext(ctx context.Context, all bool) ([]PartitionStat, erro Verbose: true, } - var errLogicalDrives error + var errFirstVol error retChan := make(chan PartitionStat) quitChan := make(chan struct{}) defer close(quitChan) @@ -95,67 +104,91 @@ func PartitionsWithContext(ctx context.Context, all bool) ([]PartitionStat, erro getPartitions := func() { defer close(retChan) - lpBuffer := make([]byte, 254) + volNameBuf := make([]uint16, volumeNameBufferLength) - diskret, _, err := procGetLogicalDriveStringsW.Call( - uintptr(len(lpBuffer)), - uintptr(unsafe.Pointer(&lpBuffer[0]))) - if diskret == 0 { - errLogicalDrives = err + nextVolHandle, _, err := procFindFirstVolumeW.Call( + uintptr(unsafe.Pointer(&volNameBuf[0])), + uintptr(volumeNameBufferLength)) + if windows.Handle(nextVolHandle) == windows.InvalidHandle { + errFirstVol = errors.WithMessagef(err, "failed to get first-volume") return } - for _, v := range lpBuffer { - if v >= 65 && v <= 90 { - path := string(v) + ":" - typepath, _ := windows.UTF16PtrFromString(path) - typeret, _, _ := procGetDriveType.Call(uintptr(unsafe.Pointer(typepath))) - if typeret == 0 { + defer procFindVolumeClose.Call(nextVolHandle) + firstVolume := true + var volPaths []string + + for { + if !firstVolume { + volNameBuf = make([]uint16, volumeNameBufferLength) + if volRet, _, err := procFindNextVolumeW.Call( + nextVolHandle, + uintptr(unsafe.Pointer(&volNameBuf[0])), + uintptr(volumeNameBufferLength)); err != nil && volRet == 0 { + + if errno, ok := err.(syscall.Errno); ok && errno == windows.ERROR_NO_MORE_FILES { + break + } + warnings.Add(errors.WithMessagef(err, "failed to find next volume")) + continue + } + } + + firstVolume = false + if volPaths, err = getVolumePaths(volNameBuf); err != nil { + warnings.Add(errors.WithMessagef(err, "failed to find paths for volume %s", windows.UTF16ToString(volNameBuf))) + continue + } + + if len(volPaths) > 0 { + volPathPtr, _ := windows.UTF16PtrFromString(volPaths[0]) + driveType, _, _ := procGetDriveTypeW.Call(uintptr(unsafe.Pointer(volPathPtr))) + if driveType == windows.DRIVE_UNKNOWN { err := windows.GetLastError() warnings.Add(err) continue } - // 2: DRIVE_REMOVABLE 3: DRIVE_FIXED 4: DRIVE_REMOTE 5: DRIVE_CDROM - - if typeret == 2 || typeret == 3 || typeret == 4 || typeret == 5 { - lpVolumeNameBuffer := make([]byte, 256) - lpVolumeSerialNumber := int64(0) - lpMaximumComponentLength := int64(0) - lpFileSystemFlags := int64(0) - lpFileSystemNameBuffer := make([]byte, 256) - volpath, _ := windows.UTF16PtrFromString(string(v) + ":/") - driveret, _, err := procGetVolumeInformation.Call( - uintptr(unsafe.Pointer(volpath)), - uintptr(unsafe.Pointer(&lpVolumeNameBuffer[0])), - uintptr(len(lpVolumeNameBuffer)), - uintptr(unsafe.Pointer(&lpVolumeSerialNumber)), - uintptr(unsafe.Pointer(&lpMaximumComponentLength)), - uintptr(unsafe.Pointer(&lpFileSystemFlags)), - uintptr(unsafe.Pointer(&lpFileSystemNameBuffer[0])), - uintptr(len(lpFileSystemNameBuffer))) - if driveret == 0 { - if typeret == 5 || typeret == 2 { - continue // device is not ready will happen if there is no disk in the drive + for _, volPath := range volPaths { + if driveType == windows.DRIVE_REMOVABLE || driveType == windows.DRIVE_FIXED || driveType == windows.DRIVE_REMOTE || driveType == windows.DRIVE_CDROM { + fsFlags, fsNameBuf := uint32(0), make([]uint16, 256) + rootPathPtr, _ := windows.UTF16PtrFromString(volPath) + volNameBuf := make([]uint16, 256) + volSerialNum := uint32(0) + maxComponentLen := uint32(0) + if driveRet, _, err := procGetVolumeInformationW.Call( + uintptr(unsafe.Pointer(rootPathPtr)), + uintptr(unsafe.Pointer(&volNameBuf[0])), + uintptr(len(volNameBuf)), + uintptr(unsafe.Pointer(&volSerialNum)), + uintptr(unsafe.Pointer(&maxComponentLen)), + uintptr(unsafe.Pointer(&fsFlags)), + uintptr(unsafe.Pointer(&fsNameBuf[0])), + uintptr(len(fsNameBuf))); err != nil && driveRet == 0 { + if driveType == windows.DRIVE_CDROM && driveType == windows.DRIVE_REMOVABLE { + continue + } + warnings.Add(errors.WithMessagef(err, "failed to get volume information")) + continue + } + opts := []string{"rw"} + if int64(fsFlags)&fileReadOnlyVolume != 0 { + opts = []string{"ro"} + } + if int64(fsFlags)&fileFileCompression != 0 { + opts = append(opts, "compress") } - warnings.Add(err) - continue - } - opts := []string{"rw"} - if lpFileSystemFlags&fileReadOnlyVolume != 0 { - opts = []string{"ro"} - } - if lpFileSystemFlags&fileFileCompression != 0 { - opts = append(opts, "compress") - } - select { - case retChan <- PartitionStat{ - Mountpoint: path, - Device: path, - Fstype: string(bytes.ReplaceAll(lpFileSystemNameBuffer, []byte("\x00"), []byte(""))), - Opts: opts, - }: - case <-quitChan: - return + path := strings.TrimRight(volPath, "\\") + + select { + case retChan <- PartitionStat{ + Mountpoint: path, + Device: path, + Fstype: windows.UTF16PtrToString(&fsNameBuf[0]), + Opts: opts, + }: + case <-quitChan: + return + } } } } @@ -169,8 +202,8 @@ func PartitionsWithContext(ctx context.Context, all bool) ([]PartitionStat, erro select { case p, ok := <-retChan: if !ok { - if errLogicalDrives != nil { - return ret, errLogicalDrives + if errFirstVol != nil { + return ret, errFirstVol } return ret, warnings.Reference() } @@ -181,6 +214,41 @@ func PartitionsWithContext(ctx context.Context, all bool) ([]PartitionStat, erro } } +// getVolumePaths returns the path for the given volume name. +func getVolumePaths(volNameBuf []uint16) ([]string, error) { + volPathsBuf := make([]uint16, volumePathBufferLength) + returnLen := uint32(0) + if result, _, err := procGetVolumePathNamesForVolumeNameW.Call( + uintptr(unsafe.Pointer(&volNameBuf[0])), + uintptr(unsafe.Pointer(&volPathsBuf[0])), + uintptr(volumePathBufferLength), + uintptr(unsafe.Pointer(&returnLen))); err != nil && result == 0 { + return nil, err + } + return split0(volPathsBuf, int(returnLen)), nil +} + +// split0 iterates through s16 upto `end` and slices `s16` into sub-slices separated by the null character (uint16(0)). +// split0 converts the sub-slices between the null characters into strings then returns them in a slice. +func split0(s16 []uint16, end int) []string { + if end > len(s16) { + end = len(s16) + } + + from, ss := 0, make([]string, 0) + + for to := 0; to < end; to++ { + if s16[to] == 0 { + if from < to && s16[from] != 0 { + ss = append(ss, string(utf16.Decode(s16[from:to]))) + } + from = to + 1 + } + } + + return ss +} + func IOCountersWithContext(ctx context.Context, names ...string) (map[string]IOCountersStat, error) { // https://github.com/giampaolo/psutil/blob/544e9daa4f66a9f80d7bf6c7886d693ee42f0a13/psutil/arch/windows/disk.c#L83 drivemap := make(map[string]IOCountersStat, 0) diff --git a/go.mod b/go.mod index cc32d8d6b..c73bdb8b2 100644 --- a/go.mod +++ b/go.mod @@ -5,6 +5,7 @@ go 1.15 require ( github.com/google/go-cmp v0.6.0 github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 + github.com/pkg/errors v0.9.1 github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c github.com/shoenig/go-m1cpu v0.1.6 github.com/stretchr/testify v1.8.4 diff --git a/go.sum b/go.sum index 091d94127..9b1f5d33b 100644 --- a/go.sum +++ b/go.sum @@ -9,6 +9,8 @@ github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 h1:6E+4a0GO5zZEnZ81pIr0yLvtUWk2if982qA3F3QD6H4= github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0/go.mod h1:zJYVVT2jmtg6P3p1VtQj7WsuWi/y4VnjVBn7F8KPB3I= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c h1:ncq/mPwQF4JjgDlrVEn3C11VoGHZN7m8qihwgMEtzYw= From a94b92cbfee29f67ac4f81589b22c136091f7cb0 Mon Sep 17 00:00:00 2001 From: Dani Louca Date: Sun, 7 Jan 2024 19:27:37 -0500 Subject: [PATCH 2/2] fix PR review Signed-off-by: Dani Louca --- disk/disk_windows.go | 16 ++++++++-------- go.mod | 1 - go.sum | 2 -- 3 files changed, 8 insertions(+), 11 deletions(-) diff --git a/disk/disk_windows.go b/disk/disk_windows.go index a85e8dc00..2ea5efdbd 100644 --- a/disk/disk_windows.go +++ b/disk/disk_windows.go @@ -11,7 +11,6 @@ import ( "unicode/utf16" "unsafe" - "github.com/pkg/errors" "github.com/shirou/gopsutil/v3/internal/common" "golang.org/x/sys/windows" "golang.org/x/sys/windows/registry" @@ -110,7 +109,7 @@ func PartitionsWithContext(ctx context.Context, all bool) ([]PartitionStat, erro uintptr(unsafe.Pointer(&volNameBuf[0])), uintptr(volumeNameBufferLength)) if windows.Handle(nextVolHandle) == windows.InvalidHandle { - errFirstVol = errors.WithMessagef(err, "failed to get first-volume") + errFirstVol = fmt.Errorf("failed to get first-volume: %w", err) return } defer procFindVolumeClose.Call(nextVolHandle) @@ -128,14 +127,14 @@ func PartitionsWithContext(ctx context.Context, all bool) ([]PartitionStat, erro if errno, ok := err.(syscall.Errno); ok && errno == windows.ERROR_NO_MORE_FILES { break } - warnings.Add(errors.WithMessagef(err, "failed to find next volume")) + warnings.Add(fmt.Errorf("failed to find next volume: %w", err)) continue } } firstVolume = false if volPaths, err = getVolumePaths(volNameBuf); err != nil { - warnings.Add(errors.WithMessagef(err, "failed to find paths for volume %s", windows.UTF16ToString(volNameBuf))) + warnings.Add(fmt.Errorf("failed to find paths for volume %s", windows.UTF16ToString(volNameBuf))) continue } @@ -154,7 +153,7 @@ func PartitionsWithContext(ctx context.Context, all bool) ([]PartitionStat, erro volNameBuf := make([]uint16, 256) volSerialNum := uint32(0) maxComponentLen := uint32(0) - if driveRet, _, err := procGetVolumeInformationW.Call( + driveRet, _, err := procGetVolumeInformationW.Call( uintptr(unsafe.Pointer(rootPathPtr)), uintptr(unsafe.Pointer(&volNameBuf[0])), uintptr(len(volNameBuf)), @@ -162,11 +161,12 @@ func PartitionsWithContext(ctx context.Context, all bool) ([]PartitionStat, erro uintptr(unsafe.Pointer(&maxComponentLen)), uintptr(unsafe.Pointer(&fsFlags)), uintptr(unsafe.Pointer(&fsNameBuf[0])), - uintptr(len(fsNameBuf))); err != nil && driveRet == 0 { - if driveType == windows.DRIVE_CDROM && driveType == windows.DRIVE_REMOVABLE { + uintptr(len(fsNameBuf))) + if err != nil && driveRet == 0 { + if driveType == windows.DRIVE_CDROM || driveType == windows.DRIVE_REMOVABLE { continue } - warnings.Add(errors.WithMessagef(err, "failed to get volume information")) + warnings.Add(fmt.Errorf("failed to get volume information: %w", err)) continue } opts := []string{"rw"} diff --git a/go.mod b/go.mod index c73bdb8b2..cc32d8d6b 100644 --- a/go.mod +++ b/go.mod @@ -5,7 +5,6 @@ go 1.15 require ( github.com/google/go-cmp v0.6.0 github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 - github.com/pkg/errors v0.9.1 github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c github.com/shoenig/go-m1cpu v0.1.6 github.com/stretchr/testify v1.8.4 diff --git a/go.sum b/go.sum index 9b1f5d33b..091d94127 100644 --- a/go.sum +++ b/go.sum @@ -9,8 +9,6 @@ github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 h1:6E+4a0GO5zZEnZ81pIr0yLvtUWk2if982qA3F3QD6H4= github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0/go.mod h1:zJYVVT2jmtg6P3p1VtQj7WsuWi/y4VnjVBn7F8KPB3I= -github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= -github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c h1:ncq/mPwQF4JjgDlrVEn3C11VoGHZN7m8qihwgMEtzYw=