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
|
package device
import (
"errors"
"fmt"
"io/fs"
deviceConfig "github.com/lxc/incus/v6/internal/server/device/config"
"github.com/lxc/incus/v6/internal/server/instance"
"github.com/lxc/incus/v6/internal/server/instance/instancetype"
"github.com/lxc/incus/v6/internal/server/network"
localUtil "github.com/lxc/incus/v6/internal/server/util"
"github.com/lxc/incus/v6/shared/revert"
"github.com/lxc/incus/v6/shared/util"
)
type nicP2P struct {
deviceCommon
}
// CanHotPlug returns whether the device can be managed whilst the instance is running. Returns true.
func (d *nicP2P) CanHotPlug() bool {
return true
}
// validateConfig checks the supplied config for correctness.
func (d *nicP2P) validateConfig(instConf instance.ConfigReader) error {
if !instanceSupported(instConf.Type(), instancetype.Container, instancetype.VM) {
return ErrUnsupportedDevType
}
optionalFields := []string{
// gendoc:generate(entity=devices, group=nic_p2p, key=name)
//
// ---
// type: string
// default: kernel assigned
// shortdesc: The name of the interface inside the instance
"name",
// gendoc:generate(entity=devices, group=nic_p2p, key=mtu)
//
// ---
// type: integer
// default: kernel assigned
// shortdesc: The Maximum Transmit Unit (MTU) of the new interface
"mtu",
// gendoc:generate(entity=devices, group=nic_p2p, key=queue.tx.length)
//
// ---
// type: integer
// shortdesc: The transmit queue length for the NIC
"queue.tx.length",
// gendoc:generate(entity=devices, group=nic_p2p, key=hwaddr)
//
// ---
// type: string
// default: randomly assigned
// shortdesc: The MAC address of the new interface
"hwaddr",
// gendoc:generate(entity=devices, group=nic_p2p, key=host_name)
//
// ---
// type: string
// default: randomly assigned
// shortdesc: The name of the interface on the host
"host_name",
// gendoc:generate(entity=devices, group=nic_p2p, key=limits.ingress)
//
// ---
// type: string
// shortdesc: I/O limit in bit/s for incoming traffic (various suffixes supported, see {ref}instances-limit-units)
"limits.ingress",
// gendoc:generate(entity=devices, group=nic_p2p, key=limits.egress)
//
// ---
// type: string
// shortdesc: I/O limit in bit/s for outgoing traffic (various suffixes supported, see {ref}instances-limit-units)
"limits.egress",
// gendoc:generate(entity=devices, group=nic_p2p, key=limits.max)
//
// ---
// type: string
// shortdesc: I/O limit in bit/s for both incoming and outgoing traffic (same as setting both limits.ingress and limits.egress)
"limits.max",
// gendoc:generate(entity=devices, group=nic_p2p, key=limits.priority)
//
// ---
// type: integer
// shortdesc: The priority for outgoing traffic, to be used by the kernel queuing discipline to prioritize network packets
"limits.priority",
// gendoc:generate(entity=devices, group=nic_p2p, key=ipv4.routes)
//
// ---
// type: string
// shortdesc: Comma-delimited list of IPv4 static routes to add on host to NIC
"ipv4.routes",
// gendoc:generate(entity=devices, group=nic_p2p, key=ipv6.routes)
//
// ---
// type: string
// shortdesc: Comma-delimited list of IPv6 static routes to add on host to NIC
"ipv6.routes",
// gendoc:generate(entity=devices, group=nic_p2p, key=boot.priotiry)
//
// ---
// type: integer
// shortdesc: Boot priority for VMs (higher value boots first)
"boot.priority",
// gendoc:generate(entity=devices, group=nic_p2p, key=io.bus)
//
// ---
// type: string
// default: `virtio`
// shortdesc: Override the bus for the device (can be `virtio` or `usb`) (VM only)
"io.bus",
}
err := d.config.Validate(nicValidationRules([]string{}, optionalFields, instConf))
if err != nil {
return err
}
return nil
}
// validateEnvironment checks the runtime environment for correctness.
func (d *nicP2P) validateEnvironment() error {
if d.inst.Type() == instancetype.Container && d.config["name"] == "" {
return errors.New("Requires name property to start")
}
return nil
}
// UpdatableFields returns a list of fields that can be updated without triggering a device remove & add.
func (d *nicP2P) UpdatableFields(oldDevice Type) []string {
// Check old and new device types match.
_, match := oldDevice.(*nicP2P)
if !match {
return []string{}
}
return []string{"limits.ingress", "limits.egress", "limits.max", "limits.priority", "ipv4.routes", "ipv6.routes"}
}
// Start is run when the device is added to a running instance or instance is starting up.
func (d *nicP2P) Start() (*deviceConfig.RunConfig, error) {
err := d.validateEnvironment()
if err != nil {
return nil, err
}
reverter := revert.New()
defer reverter.Fail()
saveData := make(map[string]string)
saveData["host_name"] = d.config["host_name"]
var peerName string
var mtu uint32
// Create veth pair and configure the peer end with custom hwaddr and mtu if supplied.
if d.inst.Type() == instancetype.Container {
if saveData["host_name"] == "" {
saveData["host_name"], err = d.generateHostName("veth", d.config["hwaddr"])
if err != nil {
return nil, err
}
}
peerName, mtu, err = networkCreateVethPair(saveData["host_name"], d.config)
} else if d.inst.Type() == instancetype.VM {
if saveData["host_name"] == "" {
saveData["host_name"], err = d.generateHostName("tap", d.config["hwaddr"])
if err != nil {
return nil, err
}
}
peerName = saveData["host_name"] // VMs use the host_name to link to the TAP FD.
mtu, err = networkCreateTap(saveData["host_name"], d.config)
}
if err != nil {
return nil, err
}
reverter.Add(func() { _ = network.InterfaceRemove(saveData["host_name"]) })
// Attempt to disable router advertisement acceptance.
err = localUtil.SysctlSet(fmt.Sprintf("net/ipv6/conf/%s/accept_ra", saveData["host_name"]), "0")
if err != nil && !errors.Is(err, fs.ErrNotExist) {
return nil, err
}
// Populate device config with volatile fields if needed.
networkVethFillFromVolatile(d.config, saveData)
// Apply host-side routes to veth interface.
err = networkNICRouteAdd(d.config["host_name"], append(util.SplitNTrimSpace(d.config["ipv4.routes"], ",", -1, true), util.SplitNTrimSpace(d.config["ipv6.routes"], ",", -1, true)...)...)
if err != nil {
return nil, err
}
// Apply host-side limits.
err = networkSetupHostVethLimits(&d.deviceCommon, nil, false)
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"},
{Key: "link", Value: peerName},
{Key: "hwaddr", Value: d.config["hwaddr"]},
}
if d.config["io.bus"] == "usb" {
runConf.UseUSBBus = true
}
if d.inst.Type() == instancetype.VM {
runConf.NetworkInterface = append(runConf.NetworkInterface,
[]deviceConfig.RunConfigItem{
{Key: "devName", Value: d.name},
{Key: "mtu", Value: fmt.Sprintf("%d", mtu)},
}...)
}
reverter.Success()
return &runConf, nil
}
// Update applies configuration changes to a started device.
func (d *nicP2P) Update(oldDevices deviceConfig.Devices, isRunning bool) error {
if !isRunning {
return nil
}
err := d.validateEnvironment()
if err != nil {
return err
}
oldConfig := oldDevices[d.name]
v := d.volatileGet()
// Populate device config with volatile fields if needed.
networkVethFillFromVolatile(d.config, v)
networkVethFillFromVolatile(oldConfig, v)
// Remove old host-side routes from veth interface.
networkNICRouteDelete(oldConfig["host_name"], append(util.SplitNTrimSpace(oldConfig["ipv4.routes"], ",", -1, true), util.SplitNTrimSpace(oldConfig["ipv6.routes"], ",", -1, true)...)...)
// Apply host-side routes to veth interface.
err = networkNICRouteAdd(d.config["host_name"], append(util.SplitNTrimSpace(d.config["ipv4.routes"], ",", -1, true), util.SplitNTrimSpace(d.config["ipv6.routes"], ",", -1, true)...)...)
if err != nil {
return err
}
// Apply host-side limits.
err = networkSetupHostVethLimits(&d.deviceCommon, oldConfig, false)
if err != nil {
return err
}
return nil
}
// Stop is run when the device is removed from the instance.
func (d *nicP2P) Stop() (*deviceConfig.RunConfig, error) {
// Populate device config with volatile fields (hwaddr and host_name) if needed.
networkVethFillFromVolatile(d.config, d.volatileGet())
err := networkClearHostVethLimits(&d.deviceCommon)
if err != nil {
return nil, err
}
runConf := deviceConfig.RunConfig{
PostHooks: []func() error{d.postStop},
}
return &runConf, nil
}
// postStop is run after the device is removed from the instance.
func (d *nicP2P) postStop() error {
defer func() {
_ = d.volatileSet(map[string]string{
"host_name": "",
})
}()
v := d.volatileGet()
networkVethFillFromVolatile(d.config, v)
if d.config["host_name"] != "" && network.InterfaceExists(d.config["host_name"]) {
// Removing host-side end of veth pair will delete the peer end too.
err := network.InterfaceRemove(d.config["host_name"])
if err != nil {
return fmt.Errorf("Failed to remove interface %s: %w", d.config["host_name"], err)
}
}
return nil
}
|