dotcloud/docker

//go:build linux

package ipvlan

import (
    "context"
    "fmt"

    "github.com/containerd/log"
    "github.com/docker/docker/errdefs"
    "github.com/docker/docker/libnetwork/driverapi"
    "github.com/docker/docker/libnetwork/netlabel"
    "github.com/docker/docker/libnetwork/ns"
    "github.com/docker/docker/libnetwork/options"
    "github.com/docker/docker/libnetwork/types"
    "github.com/docker/docker/pkg/parsers/kernel"
)

// CreateNetwork the network for the specified driver type
func (d *driver) CreateNetwork(nid string, option map[string]interface{}, nInfo driverapi.NetworkInfo, ipV4Data, ipV6Data []driverapi.IPAMData) error {
    kv, err := kernel.GetKernelVersion()
    if err != nil {
        return fmt.Errorf("failed to check kernel version for ipvlan driver support: %v", err)
    }
    // ensure Kernel version is >= v4.2 for ipvlan support
    if kv.Kernel < ipvlanKernelVer || (kv.Kernel == ipvlanKernelVer && kv.Major < ipvlanMajorVer) {
        return fmt.Errorf("kernel version failed to meet the minimum ipvlan kernel requirement of %d.%d, found %d.%d.%d",
            ipvlanKernelVer, ipvlanMajorVer, kv.Kernel, kv.Major, kv.Minor)
    }
    // reject a null v4 network if ipv4 is required
    if v, ok := option[netlabel.EnableIPv4]; ok && v.(bool) {
        if len(ipV4Data) == 0 || ipV4Data[0].Pool.String() == "0.0.0.0/0" {
            return errdefs.InvalidParameter(fmt.Errorf("ipv4 pool is empty"))
        }
    }
    // reject a null v6 network if ipv6 is required
    if v, ok := option[netlabel.EnableIPv6]; ok && v.(bool) {
        if len(ipV6Data) == 0 || ipV6Data[0].Pool.String() == "::/0" {
            return errdefs.InvalidParameter(fmt.Errorf("ipv6 pool is empty"))
        }
    }
    // parse and validate the config and bind to networkConfiguration
    config, err := parseNetworkOptions(nid, option)
    if err != nil {
        return err
    }
    config.processIPAM(ipV4Data, ipV6Data)

    // if parent interface not specified, create a dummy type link to use named dummy+net_id
    if config.Parent == "" {
        config.Parent = getDummyName(config.ID)
        config.Internal = true
    }
    foundExisting, err := d.createNetwork(config)
    if err != nil {
        return err
    }

    if foundExisting {
        return types.InternalMaskableErrorf("restoring existing network %s", config.ID)
    }

    // update persistent db, rollback on fail
    err = d.storeUpdate(config)
    if err != nil {
        d.deleteNetwork(config.ID)
        log.G(context.TODO()).Debugf("encountered an error rolling back a network create for %s : %v", config.ID, err)
        return err
    }

    return nil
}

// createNetwork is used by new network callbacks and persistent network cache
func (d *driver) createNetwork(config *configuration) (bool, error) {
    foundExisting := false
    networkList := d.getNetworks()
    for _, nw := range networkList {
        if config.Parent == nw.config.Parent {
            if config.ID != nw.config.ID {
                return false, fmt.Errorf("network %s is already using parent interface %s",
                    getDummyName(nw.config.ID), config.Parent)
            }
            log.G(context.TODO()).Debugf("Create Network for the same ID %s\n", config.ID)
            foundExisting = true
            break
        }
    }
    if !parentExists(config.Parent) {
        // Create a dummy link if a dummy name is set for parent
        if dummyName := getDummyName(config.ID); dummyName == config.Parent {
            err := createDummyLink(config.Parent, dummyName)
            if err != nil {
                return false, err
            }
            config.CreatedSlaveLink = true

            // notify the user in logs that they have limited communications
            log.G(context.TODO()).Debugf("Empty -o parent= flags limit communications to other containers inside of network: %s",
                config.Parent)
        } else {
            // if the subinterface parent_iface.vlan_id checks do not pass, return err.
            //  a valid example is 'eth0.10' for a parent iface 'eth0' with a vlan id '10'
            err := createVlanLink(config.Parent)
            if err != nil {
                return false, err
            }
            // if driver created the networks slave link, record it for future deletion
            config.CreatedSlaveLink = true
        }
    }
    if !foundExisting {
        n := &network{
            id:        config.ID,
            driver:    d,
            endpoints: endpointTable{},
            config:    config,
        }
        // add the network
        d.addNetwork(n)
    }

    return foundExisting, nil
}

// DeleteNetwork deletes the network for the specified driver type
func (d *driver) DeleteNetwork(nid string) error {
    n := d.network(nid)
    if n == nil {
        return fmt.Errorf("network id %s not found", nid)
    }
    // if the driver created the slave interface, delete it, otherwise leave it
    if ok := n.config.CreatedSlaveLink; ok {
        // if the interface exists, only delete if it matches iface.vlan or dummy.net_id naming
        if ok := parentExists(n.config.Parent); ok {
            // only delete the link if it is named the net_id
            if n.config.Parent == getDummyName(nid) {
                err := delDummyLink(n.config.Parent)
                if err != nil {
                    log.G(context.TODO()).Debugf("link %s was not deleted, continuing the delete network operation: %v",
                        n.config.Parent, err)
                }
            } else {
                // only delete the link if it matches iface.vlan naming
                err := delVlanLink(n.config.Parent)
                if err != nil {
                    log.G(context.TODO()).Debugf("link %s was not deleted, continuing the delete network operation: %v",
                        n.config.Parent, err)
                }
            }
        }
    }
    for _, ep := range n.endpoints {
        if link, err := ns.NlHandle().LinkByName(ep.srcName); err == nil {
            if err := ns.NlHandle().LinkDel(link); err != nil {
                log.G(context.TODO()).WithError(err).Warnf("Failed to delete interface (%s)'s link on endpoint (%s) delete", ep.srcName, ep.id)
            }
        }

        if err := d.storeDelete(ep); err != nil {
            log.G(context.TODO()).Warnf("Failed to remove ipvlan endpoint %.7s from store: %v", ep.id, err)
        }
    }
    // delete the *network
    d.deleteNetwork(nid)
    // delete the network record from persistent cache
    err := d.storeDelete(n.config)
    if err != nil {
        return fmt.Errorf("error deleting id %s from datastore: %v", nid, err)
    }
    return nil
}

// parseNetworkOptions parses docker network options
func parseNetworkOptions(id string, option options.Generic) (*configuration, error) {
    var (
        err    error
        config = &configuration{}
    )
    // parse generic labels first
    if genData, ok := option[netlabel.GenericData]; ok && genData != nil {
        if config, err = parseNetworkGenericOptions(genData); err != nil {
            return nil, err
        }
    }
    if val, ok := option[netlabel.Internal]; ok {
        if internal, ok := val.(bool); ok && internal {
            config.Internal = true
        }
    }

    // verify the ipvlan mode from -o ipvlan_mode option
    switch config.IpvlanMode {
    case "":
        // default to ipvlan L2 mode if -o ipvlan_mode is empty
        config.IpvlanMode = modeL2
    case modeL2, modeL3, modeL3S:
        // valid option
    default:
        return nil, fmt.Errorf("requested ipvlan mode '%s' is not valid, 'l2' mode is the ipvlan driver default", config.IpvlanMode)
    }

    // verify the ipvlan flag from -o ipvlan_flag option
    switch config.IpvlanFlag {
    case "":
        // default to bridge if -o ipvlan_flag is empty
        config.IpvlanFlag = flagBridge
    case flagBridge, flagPrivate, flagVepa:
        // valid option
    default:
        return nil, fmt.Errorf("requested ipvlan flag '%s' is not valid, 'bridge' is the ipvlan driver default", config.IpvlanFlag)
    }

    // loopback is not a valid parent link
    if config.Parent == "lo" {
        return nil, fmt.Errorf("loopback interface is not a valid ipvlan parent link")
    }

    config.ID = id
    return config, nil
}

// parseNetworkGenericOptions parse generic driver docker network options
func parseNetworkGenericOptions(data interface{}) (*configuration, error) {
    switch opt := data.(type) {
    case *configuration:
        return opt, nil
    case map[string]string:
        return newConfigFromLabels(opt), nil
    case options.Generic:
        var config *configuration
        opaqueConfig, err := options.GenerateFromModel(opt, config)
        if err != nil {
            return nil, err
        }
        return opaqueConfig.(*configuration), nil
    default:
        return nil, types.InvalidParameterErrorf("unrecognized network configuration format: %v", opt)
    }
}

// newConfigFromLabels creates a new configuration from the given labels.
func newConfigFromLabels(labels map[string]string) *configuration {
    config := &configuration{}
    for label, value := range labels {
        switch label {
        case parentOpt:
            // parse driver option '-o parent'
            config.Parent = value
        case driverModeOpt:
            // parse driver option '-o ipvlan_mode'
            config.IpvlanMode = value
        case driverFlagOpt:
            // parse driver option '-o ipvlan_flag'
            config.IpvlanFlag = value
        }
    }

    return config
}

// processIPAM parses v4 and v6 IP information and binds it to the network configuration
func (config *configuration) processIPAM(ipamV4Data, ipamV6Data []driverapi.IPAMData) {
    for _, ipd := range ipamV4Data {
        config.Ipv4Subnets = append(config.Ipv4Subnets, &ipSubnet{
            SubnetIP: ipd.Pool.String(),
            GwIP:     ipd.Gateway.String(),
        })
    }
    for _, ipd := range ipamV6Data {
        config.Ipv6Subnets = append(config.Ipv6Subnets, &ipSubnet{
            SubnetIP: ipd.Pool.String(),
            GwIP:     ipd.Gateway.String(),
        })
    }
}