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 405 406 407 408 409 410
|
package device
import (
"errors"
"fmt"
"io/fs"
"net"
"net/http"
"strconv"
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/ip"
"github.com/lxc/incus/v6/internal/server/network"
localUtil "github.com/lxc/incus/v6/internal/server/util"
"github.com/lxc/incus/v6/shared/api"
"github.com/lxc/incus/v6/shared/revert"
"github.com/lxc/incus/v6/shared/util"
)
type nicMACVLAN struct {
deviceCommon
network network.Network // Populated in validateConfig().
}
// CanHotPlug returns whether the device can be managed whilst the instance is running. Returns true.
func (d *nicMACVLAN) CanHotPlug() bool {
return true
}
// CanMigrate returns whether the device can be migrated to any other cluster member.
func (d *nicMACVLAN) CanMigrate() bool {
return d.config["network"] != ""
}
// validateConfig checks the supplied config for correctness.
func (d *nicMACVLAN) validateConfig(instConf instance.ConfigReader) error {
if !instanceSupported(instConf.Type(), instancetype.Container, instancetype.VM) {
return ErrUnsupportedDevType
}
var requiredFields []string
optionalFields := []string{
// gendoc:generate(entity=devices, group=nic_macvlan, key=name)
//
// ---
// type: string
// default: kernel assigned
// managed: no
// shortdesc: The name of the interface inside the instance
"name",
// gendoc:generate(entity=devices, group=nic_macvlan, key=network)
//
// ---
// type: string
// managed: no
// shortdesc: The managed network to link the device to (instead of specifying the `nictype` directly)
"network",
// gendoc:generate(entity=devices, group=nic_macvlan, key=parent)
//
// ---
// type: string
// managed: yes
// shortdesc: The name of the parent host device (required if specifying the `nictype` directly)
"parent",
// gendoc:generate(entity=devices, group=nic_macvlan, key=mtu)
//
// ---
// type: integer
// default: MTU of the parent device
// managed: yes
// shortdesc: The Maximum Transmit Unit (MTU) of the new interface
"mtu",
// gendoc:generate(entity=devices, group=nic_macvlan, key=hwaddr)
//
// ---
// type: string
// default: randomly assigned
// managed: no
// shortdesc: The MAC address of the new interface
"hwaddr",
// gendoc:generate(entity=devices, group=nic_macvlan, key=vlan)
//
// ---
// type: integer
// managed: no
// shortdesc: The VLAN ID to attach to
"vlan",
// gendoc:generate(entity=devices, group=nic_macvlan, key=boot.priority)
//
// ---
// type: integer
// managed: no
// shortdesc: Boot priority for VMs (higher value boots first)
"boot.priority",
// gendoc:generate(entity=devices, group=nic_macvlan, key=gvrp)
//
// ---
// type: bool
// default: false
// managed: no
// shortdesc: Register VLAN using GARP VLAN Registration Protocol
"gvrp",
// gendoc:generate(entity=devices, group=nic_macvlan, key=mode)
//
// ---
// type: string
// default: bridge
// managed: no
// shortdesc: Macvlan mode (one of `bridge`, `vepa`, `passthru` or `private`)
"mode",
// gendoc:generate(entity=devices, group=nic_macvlan, key=io.bus)
//
// ---
// type: string
// default: `virtio`
// managed: no
// shortdesc: Override the bus for the device (can be `virtio` or `usb`) (VM only)
"io.bus",
}
// Check that if network proeperty is set that conflicting keys are not present.
if d.config["network"] != "" {
requiredFields = append(requiredFields, "network")
bannedKeys := []string{"nictype", "parent", "mtu", "vlan", "gvrp", "mode"}
for _, bannedKey := range bannedKeys {
if d.config[bannedKey] != "" {
return fmt.Errorf("Cannot use %q property in conjunction with %q property", bannedKey, "network")
}
}
// If network property is specified, lookup network settings and apply them to the device's config.
// api.ProjectDefaultName is used here as macvlan networks don't support projects.
var err error
d.network, err = network.LoadByName(d.state, api.ProjectDefaultName, d.config["network"])
if err != nil {
return fmt.Errorf("Error loading network config for %q: %w", d.config["network"], err)
}
if d.network.Status() != api.NetworkStatusCreated {
return errors.New("Specified network is not fully created")
}
if d.network.Type() != "macvlan" {
return errors.New("Specified network must be of type macvlan")
}
netConfig := d.network.Config()
// Get actual parent device from network's parent setting.
d.config["parent"] = netConfig["parent"]
// Copy certain keys verbatim from the network's settings.
inheritKeys := []string{"mtu", "vlan", "gvrp"}
for _, inheritKey := range inheritKeys {
_, found := netConfig[inheritKey]
if found {
d.config[inheritKey] = netConfig[inheritKey]
}
}
} else {
// If no network property supplied, then parent property is required.
requiredFields = append(requiredFields, "parent")
}
err := d.config.Validate(nicValidationRules(requiredFields, optionalFields, instConf))
if err != nil {
return err
}
return nil
}
// PreStartCheck checks the managed parent network is available (if relevant).
func (d *nicMACVLAN) PreStartCheck() error {
// Non-managed network NICs are not relevant for checking managed network availability.
if d.network == nil {
return nil
}
// If managed network is not available, don't try and start instance.
if d.network.LocalStatus() == api.NetworkStatusUnavailable {
return api.StatusErrorf(http.StatusServiceUnavailable, "Network %q unavailable on this server", d.network.Name())
}
return nil
}
// validateEnvironment checks the runtime environment for correctness.
func (d *nicMACVLAN) 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
}
// Start is run when the device is added to a running instance or instance is starting up.
func (d *nicMACVLAN) Start() (*deviceConfig.RunConfig, error) {
err := d.validateEnvironment()
if err != nil {
return nil, err
}
// Lock to avoid issues with containers starting in parallel.
networkCreateSharedDeviceLock.Lock()
defer networkCreateSharedDeviceLock.Unlock()
reverter := revert.New()
defer reverter.Fail()
saveData := make(map[string]string)
// Decide which parent we should use based on VLAN setting.
actualParentName := network.GetHostDevice(d.config["parent"], d.config["vlan"])
// Record the temporary device name used for deletion later.
saveData["host_name"], err = d.generateHostName("mac", d.config["hwaddr"])
if err != nil {
return nil, err
}
// Create VLAN parent device if needed.
statusDev, err := networkCreateVlanDeviceIfNeeded(d.state, d.config["parent"], actualParentName, d.config["vlan"], util.IsTrue(d.config["gvrp"]))
if err != nil {
return nil, err
}
// Record whether we created the parent device or not so it can be removed on stop.
saveData["last_state.created"] = fmt.Sprintf("%t", statusDev != "existing")
if util.IsTrue(saveData["last_state.created"]) {
reverter.Add(func() {
_ = networkRemoveInterfaceIfNeeded(d.state, actualParentName, d.inst, d.config["parent"], d.config["vlan"])
})
}
// Create MACVLAN interface.
link := &ip.Macvlan{
Link: ip.Link{
Name: saveData["host_name"],
Parent: actualParentName,
},
}
mode := d.config["mode"]
if mode != "" {
// Validate the provided mode.
switch mode {
case "bridge", "vepa", "passthru", "private":
link.Mode = mode
default:
return nil, fmt.Errorf("Invalid MACVLAN mode specified: %q", mode)
}
} else {
// Default to bridge mode if not specified.
link.Mode = "bridge"
}
// Set the MAC address.
if d.config["hwaddr"] != "" {
hwaddr, err := net.ParseMAC(d.config["hwaddr"])
if err != nil {
return nil, fmt.Errorf("Failed parsing MAC address %q: %w", d.config["hwaddr"], err)
}
link.Address = hwaddr
}
// 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.MTU = uint32(mtu)
}
if d.inst.Type() == instancetype.VM {
// Enable all multicast processing which is required for IPv6 NDP functionality.
link.AllMulticast = true
// Bring the interface up on host side.
link.Up = true
// Create macvtap interface using common macvlan settings.
link := &ip.Macvtap{
Macvlan: *link,
}
err = link.Add()
if err != nil {
return nil, err
}
} else {
// Create macvlan interface.
err = link.Add()
if err != nil {
return nil, err
}
}
reverter.Add(func() { _ = network.InterfaceRemove(saveData["host_name"]) })
if d.inst.Type() == instancetype.VM {
// Disable IPv6 on host interface to avoid getting IPv6 link-local addresses unnecessarily.
err = localUtil.SysctlSet(fmt.Sprintf("net/ipv6/conf/%s/disable_ipv6", link.Name), "1")
if err != nil && !errors.Is(err, fs.ErrNotExist) {
return nil, fmt.Errorf("Failed to disable IPv6 on host interface %q: %w", link.Name, 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: saveData["host_name"]},
{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: d.config["mtu"]},
}...)
}
reverter.Success()
return &runConf, nil
}
// Stop is run when the device is removed from the instance.
func (d *nicMACVLAN) Stop() (*deviceConfig.RunConfig, error) {
v := d.volatileGet()
runConf := deviceConfig.RunConfig{
PostHooks: []func() error{d.postStop},
NetworkInterface: []deviceConfig.RunConfigItem{
{Key: "link", Value: v["host_name"]},
},
}
return &runConf, nil
}
// postStop is run after the device is removed from the instance.
func (d *nicMACVLAN) postStop() error {
defer func() {
_ = d.volatileSet(map[string]string{
"host_name": "",
"last_state.hwaddr": "",
"last_state.mtu": "",
"last_state.created": "",
})
}()
errs := []error{}
v := d.volatileGet()
// Delete the detached device.
if v["host_name"] != "" && util.PathExists(fmt.Sprintf("/sys/class/net/%s", v["host_name"])) {
err := network.InterfaceRemove(v["host_name"])
if err != nil {
errs = append(errs, err)
}
}
// This will delete the parent interface if we created it for VLAN parent.
if util.IsTrue(v["last_state.created"]) {
actualParentName := network.GetHostDevice(d.config["parent"], d.config["vlan"])
err := networkRemoveInterfaceIfNeeded(d.state, actualParentName, d.inst, d.config["parent"], d.config["vlan"])
if err != nil {
errs = append(errs, err)
}
}
if len(errs) > 0 {
return fmt.Errorf("%v", errs)
}
return nil
}
|