moby/libnetwork/drivers/bridge/error.go

package bridge

import (
	"errors"
	"fmt"
	"net"
)

var (
	// ErrConfigExists error is returned when driver already has a config applied.
	ErrConfigExists = errors.New("configuration already exists, bridge configuration can be applied only once")

	// ErrInvalidDriverConfig error is returned when Bridge Driver is passed an invalid config
	ErrInvalidDriverConfig = errors.New("Invalid configuration passed to Bridge Driver")

	// ErrInvalidNetworkConfig error is returned when a network is created on a driver without valid config.
	ErrInvalidNetworkConfig = errors.New("trying to create a network on a driver without valid config")

	// ErrInvalidContainerConfig error is returned when a endpoint create is attempted with an invalid configuration.
	ErrInvalidContainerConfig = errors.New("Error in joining a container due to invalid configuration")

	// ErrInvalidEndpointConfig error is returned when a endpoint create is attempted with an invalid endpoint configuration.
	ErrInvalidEndpointConfig = errors.New("trying to create an endpoint with an invalid endpoint configuration")

	// ErrNetworkExists error is returned when a network already exists and another network is created.
	ErrNetworkExists = errors.New("network already exists, bridge can only have one network")

	// ErrIfaceName error is returned when a new name could not be generated.
	ErrIfaceName = errors.New("failed to find name for new interface")

	// ErrNoIPAddr error is returned when bridge has no IPv4 address configured.
	ErrNoIPAddr = errors.New("bridge has no IPv4 address configured")

	// ErrInvalidGateway is returned when the user provided default gateway (v4/v6) is not not valid.
	ErrInvalidGateway = errors.New("default gateway ip must be part of the network")

	// ErrInvalidContainerSubnet is returned when the container subnet (FixedCIDR) is not valid.
	ErrInvalidContainerSubnet = errors.New("container subnet must be a subset of bridge network")

	// ErrInvalidMtu is returned when the user provided MTU is not valid.
	ErrInvalidMtu = errors.New("invalid MTU number")
)

// ErrInvalidPort is returned when the container or host port specified in the port binding is not valid.
type ErrInvalidPort string

func (ip ErrInvalidPort) Error() string {
	return fmt.Sprintf("invalid transport port: %s", string(ip))
}

// ErrUnsupportedAddressType is returned when the specified address type is not supported.
type ErrUnsupportedAddressType string

func (uat ErrUnsupportedAddressType) Error() string {
	return fmt.Sprintf("unsupported address type: %s", string(uat))
}

// ErrInvalidAddressBinding is returned when the host address specfied in the port binding is not valid.
type ErrInvalidAddressBinding string

func (iab ErrInvalidAddressBinding) Error() string {
	return fmt.Sprintf("invalid host address in port binding: %s", string(iab))
}

// ActiveEndpointsError is returned when there are
// still active endpoints in the network being deleted.
type ActiveEndpointsError string

func (aee ActiveEndpointsError) Error() string {
	return fmt.Sprintf("network %s has active endpoint", string(aee))
}

// InvalidNetworkIDError is returned when the passed
// network id for an existing network is not a known id.
type InvalidNetworkIDError string

func (inie InvalidNetworkIDError) Error() string {
	return fmt.Sprintf("invalid network id %s", string(inie))
}

// InvalidEndpointIDError is returned when the passed
// endpoint id is not valid.
type InvalidEndpointIDError string

func (ieie InvalidEndpointIDError) Error() string {
	return fmt.Sprintf("invalid endpoint id: %s", string(ieie))
}

// InvalidSandboxIDError is returned when the passed
// sandbox id valid.
type InvalidSandboxIDError string

func (isie InvalidSandboxIDError) Error() string {
	return fmt.Sprintf("invalid sanbox id: %s", string(isie))
}

// EndpointNotFoundError is returned when the no endpoint
// with the passed endpoint id is found.
type EndpointNotFoundError string

func (enfe EndpointNotFoundError) Error() string {
	return fmt.Sprintf("endpoint not found: %s", string(enfe))
}

// NonDefaultBridgeExistError is returned when a non-default
// bridge config is passed but it does not already exist.
type NonDefaultBridgeExistError string

func (ndbee NonDefaultBridgeExistError) Error() string {
	return fmt.Sprintf("bridge device with non default name %s must be created manually", string(ndbee))
}

// FixedCIDRv4Error is returned when fixed-cidrv4 configuration
// failed.
type FixedCIDRv4Error struct {
	net    *net.IPNet
	subnet *net.IPNet
	err    error
}

func (fcv4 *FixedCIDRv4Error) Error() string {
	return fmt.Sprintf("setup FixedCIDRv4 failed for subnet %s in %s: %v", fcv4.subnet, fcv4.net, fcv4.err)
}

// FixedCIDRv6Error is returned when fixed-cidrv6 configuration
// failed.
type FixedCIDRv6Error struct {
	net *net.IPNet
	err error
}

func (fcv6 *FixedCIDRv6Error) Error() string {
	return fmt.Sprintf("setup FixedCIDRv6 failed for subnet %s in %s: %v", fcv6.net, fcv6.net, fcv6.err)
}

type ipForwardCfgError bridgeInterface

func (i *ipForwardCfgError) Error() string {
	return fmt.Sprintf("unexpected request to enable IP Forwarding for: %v", *i)
}

type ipTableCfgError string

func (name ipTableCfgError) Error() string {
	return fmt.Sprintf("unexpected request to set IP tables for interface: %s", string(name))
}

// IPv4AddrRangeError is returned when a valid IP address range couldn't be found.
type IPv4AddrRangeError string

func (name IPv4AddrRangeError) Error() string {
	return fmt.Sprintf("can't find an address range for interface %q", string(name))
}

// IPv4AddrAddError is returned when IPv4 address could not be added to the bridge.
type IPv4AddrAddError struct {
	ip  *net.IPNet
	err error
}

func (ipv4 *IPv4AddrAddError) Error() string {
	return fmt.Sprintf("failed to add IPv4 address %s to bridge: %v", ipv4.ip, ipv4.err)
}

// IPv6AddrAddError is returned when IPv6 address could not be added to the bridge.
type IPv6AddrAddError struct {
	ip  *net.IPNet
	err error
}

func (ipv6 *IPv6AddrAddError) Error() string {
	return fmt.Sprintf("failed to add IPv6 address %s to bridge: %v", ipv6.ip, ipv6.err)
}

// IPv4AddrNoMatchError is returned when the bridge's IPv4 address does not match configured.
type IPv4AddrNoMatchError struct {
	ip    net.IP
	cfgIP net.IP
}

func (ipv4 *IPv4AddrNoMatchError) Error() string {
	return fmt.Sprintf("bridge IPv4 (%s) does not match requested configuration %s", ipv4.ip, ipv4.cfgIP)
}

// IPv6AddrNoMatchError is returned when the bridge's IPv6 address does not match configured.
type IPv6AddrNoMatchError net.IPNet

func (ipv6 *IPv6AddrNoMatchError) Error() string {
	return fmt.Sprintf("bridge IPv6 addresses do not match the expected bridge configuration %s", ipv6)
}