ClearML/go-nvlib
1
0
Fork 0
mirror of https://github.com/clearml/go-nvlib synced 2025-06-26 18:28:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Address golangci-lint warnings

Browse Source 
Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
This commit is contained in:
Carlos Eduardo Arango Gutierrez
2024-04-04 13:09:04 +02:00
parent ab773cb50a
commit 48789b76df
34 changed files with 328 additions and 292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
pkg/nvmdev/mock.go
View File

@@ -25,14 +25,14 @@ import (
"github.com/NVIDIA/go-nvlib/pkg/nvpci/bytes"
)
// MockNvmdev mock mdev device
// MockNvmdev mock mdev device.
type MockNvmdev struct {
*nvmdev
}
var _ Interface = (*MockNvmdev)(nil)
// NewMock creates new mock mediated (vGPU) and parent PCI devices and removes old devices
// NewMock creates new mock mediated (vGPU) and parent PCI devices and removes old devices.
func NewMock() (mock *MockNvmdev, rerr error) {
mdevParentsRootDir, err := os.MkdirTemp(os.TempDir(), "")
if err != nil {
@@ -60,13 +60,13 @@ func NewMock() (mock *MockNvmdev, rerr error) {
return mock, nil
}
// Cleanup removes the mocked mediated (vGPU) and parent PCI devices root folders
// Cleanup removes the mocked mediated (vGPU) and parent PCI devices root folders.
func (m *MockNvmdev) Cleanup() {
os.RemoveAll(m.mdevParentsRoot)
os.RemoveAll(m.mdevDevicesRoot)
}
// AddMockA100Parent creates an A100 like parent GPU mock device
// AddMockA100Parent creates an A100 like parent GPU mock device.
func (m *MockNvmdev) AddMockA100Parent(address string, numaNode int) error {
deviceDir := filepath.Join(m.mdevParentsRoot, address)
err := os.MkdirAll(deviceDir, 0755)
@@ -220,6 +220,9 @@ func (m *MockNvmdev) AddMockA100Mdev(uuid string, mdevType string, mdevTypeDir s
return err
}
err = os.Symlink(filepath.Join(mdevDeviceDir, "vfio_mdev"), filepath.Join(mdevDeviceDir, "driver"))
if err != nil {
return err
}
_, err = os.Create(filepath.Join(mdevDeviceDir, "200"))
if err != nil {

32
pkg/nvmdev/nvmdev.go
View File

@@ -33,7 +33,7 @@ const (
mdevDevicesRoot = "/sys/bus/mdev/devices"
)
// Interface allows us to get a list of NVIDIA MDEV (vGPU) and parent devices
// Interface allows us to get a list of NVIDIA MDEV (vGPU) and parent devices.
type Interface interface {
GetAllDevices() ([]*Device, error)
GetAllParentDevices() ([]*ParentDevice, error)
@@ -46,13 +46,13 @@ type nvmdev struct {
var _ Interface = (*nvmdev)(nil)
// ParentDevice represents an NVIDIA parent PCI device
// ParentDevice represents an NVIDIA parent PCI device.
type ParentDevice struct {
*nvpci.NvidiaPCIDevice
mdevPaths map[string]string
}
// Device represents an NVIDIA MDEV (vGPU) device
// Device represents an NVIDIA MDEV (vGPU) device.
type Device struct {
Path string
UUID string
@@ -62,12 +62,12 @@ type Device struct {
Parent *ParentDevice
}
// New interface that allows us to get a list of all NVIDIA parent and MDEV (vGPU) devices
// New interface that allows us to get a list of all NVIDIA parent and MDEV (vGPU) devices.
func New() Interface {
return &nvmdev{mdevParentsRoot, mdevDevicesRoot}
}
// GetAllParentDevices returns all NVIDIA Parent PCI devices on the system
// GetAllParentDevices returns all NVIDIA Parent PCI devices on the system.
func (m *nvmdev) GetAllParentDevices() ([]*ParentDevice, error) {
deviceDirs, err := os.ReadDir(m.mdevParentsRoot)
if err != nil {
@@ -101,7 +101,7 @@ func (m *nvmdev) GetAllParentDevices() ([]*ParentDevice, error) {
return nvdevices, nil
}
// GetAllDevices returns all NVIDIA mdev (vGPU) devices on the system
// GetAllDevices returns all NVIDIA mdev (vGPU) devices on the system.
func (m *nvmdev) GetAllDevices() ([]*Device, error) {
deviceDirs, err := os.ReadDir(m.mdevDevicesRoot)
if err != nil {
@@ -123,7 +123,7 @@ func (m *nvmdev) GetAllDevices() ([]*Device, error) {
return nvdevices, nil
}
// NewDevice constructs a Device, which represents an NVIDIA mdev (vGPU) device
// NewDevice constructs a Device, which represents an NVIDIA mdev (vGPU) device.
func NewDevice(root string, uuid string) (*Device, error) {
path := path.Join(root, uuid)
@@ -240,14 +240,14 @@ func (m mdev) iommuGroup() (int, error) {
return int(iommuGroup), nil
}
// NewParentDevice constructs a ParentDevice
// NewParentDevice constructs a ParentDevice.
func NewParentDevice(devicePath string) (*ParentDevice, error) {
nvdevice, err := newNvidiaPCIDeviceFromPath(devicePath)
if err != nil {
return nil, fmt.Errorf("failed to construct NVIDIA PCI device: %v", err)
}
if nvdevice == nil {
// not a NVIDIA device
// not a NVIDIA device.
return nil, err
}
@@ -275,7 +275,7 @@ func NewParentDevice(devicePath string) (*ParentDevice, error) {
return &ParentDevice{nvdevice, mdevTypesMap}, err
}
// CreateMDEVDevice creates a mediated device (vGPU) on the parent GPU
// CreateMDEVDevice creates a mediated device (vGPU) on the parent GPU.
func (p *ParentDevice) CreateMDEVDevice(mdevType string, id string) error {
mdevPath, ok := p.mdevPaths[mdevType]
if !ok {
@@ -292,7 +292,7 @@ func (p *ParentDevice) CreateMDEVDevice(mdevType string, id string) error {
return nil
}
// DeleteMDEVDevice deletes a mediated device (vGPU)
// DeleteMDEVDevice deletes a mediated device (vGPU).
func (p *ParentDevice) DeleteMDEVDevice(id string) error {
removeFile, err := os.OpenFile(filepath.Join(p.Path, id, "remove"), os.O_WRONLY|os.O_SYNC, 0200)
if err != nil {
@@ -306,7 +306,7 @@ func (p *ParentDevice) DeleteMDEVDevice(id string) error {
return nil
}
// Delete deletes a mediated device (vGPU)
// Delete deletes a mediated device (vGPU).
func (m *Device) Delete() error {
removeFile, err := os.OpenFile(filepath.Join(m.Path, "remove"), os.O_WRONLY|os.O_SYNC, 0200)
if err != nil {
@@ -320,7 +320,7 @@ func (m *Device) Delete() error {
return nil
}
// GetPhysicalFunction gets the physical PCI device backing a 'parent' device
// GetPhysicalFunction gets the physical PCI device backing a 'parent' device.
func (p *ParentDevice) GetPhysicalFunction() (*nvpci.NvidiaPCIDevice, error) {
if !p.IsVF {
return p.NvidiaPCIDevice, nil
@@ -334,18 +334,18 @@ func (p *ParentDevice) GetPhysicalFunction() (*nvpci.NvidiaPCIDevice, error) {
return newNvidiaPCIDeviceFromPath(physfnPath)
}
// GetPhysicalFunction gets the physical PCI device that a vGPU is created on
// GetPhysicalFunction gets the physical PCI device that a vGPU is created on.
func (m *Device) GetPhysicalFunction() (*nvpci.NvidiaPCIDevice, error) {
return m.Parent.GetPhysicalFunction()
}
// IsMDEVTypeSupported checks if the mdevType is supported by the GPU
// IsMDEVTypeSupported checks if the mdevType is supported by the GPU.
func (p *ParentDevice) IsMDEVTypeSupported(mdevType string) bool {
_, found := p.mdevPaths[mdevType]
return found
}
// IsMDEVTypeAvailable checks if a vGPU instance of mdevType can be created on the parent GPU
// IsMDEVTypeAvailable checks if a vGPU instance of mdevType can be created on the parent GPU.
func (p *ParentDevice) IsMDEVTypeAvailable(mdevType string) (bool, error) {
availableInstances, err := p.GetAvailableMDEVInstances(mdevType)
if err != nil {

3
pkg/nvmdev/nvmdev_test.go
View File

@@ -17,8 +17,9 @@
package nvmdev
import (
"github.com/stretchr/testify/require"
"testing"
"github.com/stretchr/testify/require"
)
func TestNvmdev(t *testing.T) {