1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
|
package device
import (
"errors"
"fmt"
"os"
"path/filepath"
"strconv"
"strings"
"github.com/lxc/incus/v6/internal/linux"
deviceConfig "github.com/lxc/incus/v6/internal/server/device/config"
pcidev "github.com/lxc/incus/v6/internal/server/device/pci"
"github.com/lxc/incus/v6/internal/server/instance"
"github.com/lxc/incus/v6/internal/server/instance/instancetype"
"github.com/lxc/incus/v6/internal/server/ip"
"github.com/lxc/incus/v6/internal/server/network"
"github.com/lxc/incus/v6/shared/api"
"github.com/lxc/incus/v6/shared/resources"
"github.com/lxc/incus/v6/shared/revert"
"github.com/lxc/incus/v6/shared/util"
)
type infinibandSRIOV struct {
deviceCommon
}
// validateConfig checks the supplied config for correctness.
func (d *infinibandSRIOV) validateConfig(instConf instance.ConfigReader) error {
requiredFields := []string{"parent"}
optionalFields := []string{
"name",
"mtu",
"hwaddr",
}
rules := nicValidationRules(requiredFields, optionalFields, instConf)
rules["hwaddr"] = func(value string) error {
if value == "" {
return nil
}
return infinibandValidMAC(value)
}
err := d.config.Validate(rules)
if err != nil {
return err
}
return nil
}
// validateEnvironment checks the runtime environment for correctness.
func (d *infinibandSRIOV) validateEnvironment() error {
if d.inst.Type() == instancetype.Container && d.config["name"] == "" {
return errors.New("Requires name property to start")
}
if !util.PathExists(fmt.Sprintf("/sys/class/net/%s", d.config["parent"])) {
return fmt.Errorf("Parent device '%s' doesn't exist", d.config["parent"])
}
return nil
}
func (d *infinibandSRIOV) startContainer() (*deviceConfig.RunConfig, error) {
saveData := make(map[string]string)
// Load network interface info.
nics, err := resources.GetNetwork()
if err != nil {
return nil, err
}
// Filter the network interfaces to just infiniband devices related to parent.
ibDevs := infinibandDevices(nics, d.config["parent"])
// We don't count the parent as an available VF.
delete(ibDevs, d.config["parent"])
// Load any interfaces already allocated to other devices.
reservedDevices, err := network.SRIOVGetHostDevicesInUse(d.state)
if err != nil {
return nil, err
}
// Remove reserved devices from available list.
for k := range reservedDevices {
delete(ibDevs, k)
}
if len(ibDevs) < 1 {
return nil, errors.New("All virtual functions on parent device are already in use")
}
// Get first VF device that is free.
var vfDev *api.ResourcesNetworkCardPort
for _, v := range ibDevs {
vfDev = v
break
}
saveData["host_name"] = vfDev.ID
// Record hwaddr and mtu before potentially modifying them.
err = networkSnapshotPhysicalNIC(saveData["host_name"], saveData)
if err != nil {
return nil, err
}
// Set the MAC address.
if d.config["hwaddr"] != "" {
err := infinibandSetDevMAC(saveData["host_name"], d.config["hwaddr"])
if err != nil {
return nil, fmt.Errorf("Failed to set the MAC address: %s", err)
}
}
// Set the MTU.
if d.config["mtu"] != "" {
mtu, err := strconv.ParseUint(d.config["mtu"], 10, 32)
if err != nil {
return nil, fmt.Errorf("Invalid MTU specified %q: %w", d.config["mtu"], err)
}
link := &ip.Link{Name: saveData["host_name"]}
err = link.SetMTU(uint32(mtu))
if err != nil {
return nil, fmt.Errorf("Failed setting MTU %q on %q: %w", d.config["mtu"], saveData["host_name"], err)
}
}
runConf := deviceConfig.RunConfig{}
// Configure runConf with infiniband setup instructions.
err = infinibandAddDevices(d.state, d.inst.DevicesPath(), d.name, vfDev, &runConf)
if err != nil {
return nil, err
}
err = d.volatileSet(saveData)
if err != nil {
return nil, err
}
runConf.NetworkInterface = []deviceConfig.RunConfigItem{
{Key: "type", Value: "phys"},
{Key: "name", Value: d.config["name"]},
{Key: "flags", Value: "up"},
{Key: "link", Value: saveData["host_name"]},
}
return &runConf, nil
}
func (d *infinibandSRIOV) startVM() (*deviceConfig.RunConfig, error) {
saveData := make(map[string]string)
err := linux.LoadModule("vfio-pci")
if err != nil {
return nil, fmt.Errorf("Error loading %q module: %w", "vfio-pci", err)
}
// Load network interface info.
nics, err := resources.GetNetwork()
if err != nil {
return nil, err
}
var parentPCIAddress string
for _, card := range nics.Cards {
found := false
for _, port := range card.Ports {
if port.ID == d.config["parent"] {
found = true
break
}
}
if !found {
continue
}
parentPCIAddress = card.PCIAddress
break
}
// Get PCI information about the GPU device.
devicePath := filepath.Join("/sys/bus/pci/devices", parentPCIAddress)
pciParentDev, err := pcidev.ParseUeventFile(filepath.Join(devicePath, "uevent"))
if err != nil {
return nil, fmt.Errorf("Failed to get PCI device info for %q: %w", parentPCIAddress, err)
}
vfID, err := d.findFreeVirtualFunction(pciParentDev)
if err != nil {
return nil, fmt.Errorf("Failed to find free virtual function: %w", err)
}
if vfID == -1 {
return nil, errors.New("All virtual functions on parent device are already in use")
}
vfPCIDev, err := d.setupSriovParent(parentPCIAddress, vfID, saveData)
if err != nil {
return nil, err
}
pciIOMMUGroup, err := pcidev.DeviceIOMMUGroup(vfPCIDev.SlotName)
if err != nil {
return nil, err
}
err = d.volatileSet(saveData)
if err != nil {
return nil, err
}
runConf := deviceConfig.RunConfig{}
runConf.NetworkInterface = []deviceConfig.RunConfigItem{
{Key: "type", Value: "phys"},
{Key: "name", Value: d.config["name"]},
{Key: "flags", Value: "up"},
}
runConf.NetworkInterface = append(runConf.NetworkInterface, []deviceConfig.RunConfigItem{
{Key: "devName", Value: d.name},
{Key: "pciSlotName", Value: vfPCIDev.SlotName},
{Key: "pciIOMMUGroup", Value: fmt.Sprintf("%d", pciIOMMUGroup)},
}...)
return &runConf, nil
}
// Start is run when the device is added to a running instance or instance is starting up.
func (d *infinibandSRIOV) Start() (*deviceConfig.RunConfig, error) {
err := d.validateEnvironment()
if err != nil {
return nil, err
}
if d.inst.Type() == instancetype.VM {
return d.startVM()
}
return d.startContainer()
}
// Stop is run when the device is removed from the instance.
func (d *infinibandSRIOV) Stop() (*deviceConfig.RunConfig, error) {
v := d.volatileGet()
runConf := deviceConfig.RunConfig{
PostHooks: []func() error{d.postStop},
NetworkInterface: []deviceConfig.RunConfigItem{{Key: "link", Value: v["host_name"]}},
}
if d.inst.Type() == instancetype.Container {
err := unixDeviceRemove(d.inst.DevicesPath(), IBDevPrefix, d.name, "", &runConf)
if err != nil {
return nil, err
}
}
return &runConf, nil
}
// postStop is run after the device is removed from the instance.
func (d *infinibandSRIOV) postStop() error {
defer func() {
_ = d.volatileSet(map[string]string{
"host_name": "",
"last_state.hwaddr": "",
"last_state.mtu": "",
"last_state.pci.slot.name": "",
"last_state.pci.driver": "",
"last_state.pci.parent": "",
})
}()
if d.inst.Type() == instancetype.Container {
// Remove infiniband host files for this device.
err := unixDeviceDeleteFiles(d.state, d.inst.DevicesPath(), IBDevPrefix, d.name, "")
if err != nil {
return fmt.Errorf("Failed to delete files for device '%s': %w", d.name, err)
}
}
// Restore hwaddr and mtu.
v := d.volatileGet()
if v["host_name"] != "" {
err := networkRestorePhysicalNIC(v["host_name"], v)
if err != nil {
return err
}
}
// Unbind from vfio-pci and bind back to host driver.
if d.inst.Type() == instancetype.VM && v["last_state.pci.slot.name"] != "" {
pciDev := pcidev.Device{
Driver: "vfio-pci",
SlotName: v["last_state.pci.slot.name"],
}
// Unbind VF device from the host so that the restored settings will take effect when we rebind it.
err := pcidev.DeviceUnbind(pciDev)
if err != nil {
return err
}
err = pcidev.DeviceDriverOverride(pciDev, v["last_state.pci.driver"])
if err != nil {
return err
}
}
return nil
}
// setupSriovParent configures a SR-IOV virtual function (VF) device on parent and stores original properties of
// the physical device into voltatile for restoration on detach. Returns VF PCI device info.
func (d *infinibandSRIOV) setupSriovParent(parentPCIAddress string, vfID int, volatile map[string]string) (pcidev.Device, error) {
reverter := revert.New()
defer reverter.Fail()
volatile["last_state.pci.parent"] = parentPCIAddress
volatile["last_state.vf.id"] = fmt.Sprintf("%d", vfID)
volatile["last_state.created"] = "false" // Indicates don't delete device at stop time.
// Get VF device's PCI Slot Name so we can unbind and rebind it from the host.
vfPCIDev, err := d.getVFDevicePCISlot(parentPCIAddress, volatile["last_state.vf.id"])
if err != nil {
return vfPCIDev, err
}
// Unbind VF device from the host so that the settings will take effect when we rebind it.
err = pcidev.DeviceUnbind(vfPCIDev)
if err != nil {
return vfPCIDev, err
}
reverter.Add(func() { _ = pcidev.DeviceProbe(vfPCIDev) })
// Register VF device with vfio-pci driver so it can be passed to VM.
err = pcidev.DeviceDriverOverride(vfPCIDev, "vfio-pci")
if err != nil {
return vfPCIDev, err
}
// Record original driver used by VF device for restore.
volatile["last_state.pci.driver"] = vfPCIDev.Driver
reverter.Success()
return vfPCIDev, nil
}
// getVFDevicePCISlot returns the PCI slot name for a PCI virtual function device.
func (d *infinibandSRIOV) getVFDevicePCISlot(parentPCIAddress string, vfID string) (pcidev.Device, error) {
ueventFile := fmt.Sprintf("/sys/bus/pci/devices/%s/virtfn%s/uevent", parentPCIAddress, vfID)
pciDev, err := pcidev.ParseUeventFile(ueventFile)
if err != nil {
return pciDev, err
}
return pciDev, nil
}
func (d *infinibandSRIOV) findFreeVirtualFunction(parentDev pcidev.Device) (int, error) {
// Get number of currently enabled VFs.
sriovNumVFs := fmt.Sprintf("/sys/bus/pci/devices/%s/sriov_numvfs", parentDev.SlotName)
sriovNumVfsBuf, err := os.ReadFile(sriovNumVFs)
if err != nil {
return 0, err
}
sriovNumVfsStr := strings.TrimSpace(string(sriovNumVfsBuf))
sriovNum, err := strconv.Atoi(sriovNumVfsStr)
if err != nil {
return 0, err
}
vfID := -1
for i := range sriovNum {
pciDev, err := pcidev.ParseUeventFile(fmt.Sprintf("/sys/bus/pci/devices/%s/virtfn%d/uevent", parentDev.SlotName, i))
if err != nil {
return 0, err
}
// We assume the virtual function is free if there's no driver bound to it.
if pciDev.Driver == "" {
vfID = i
break
}
}
return vfID, nil
}
|