Applied changes to clean up the patch

Signed-off-by: Flavio Crisciani <flavio.crisciani@docker.com>

Applied changes to clean up the patch

Signed-off-by: Flavio Crisciani <flavio.crisciani@docker.com>

Author: Flavio Crisciani

config/config.go

@@ -41,7 +41,7 @@ type DaemonCfg struct {
 	DriverCfg              map[string]interface{}
 	ClusterProvider        cluster.Provider
 	NetworkControlPlaneMTU int
-	DefaultAddressPool     []*ipamutils.PredefinedPools
+	DefaultAddressPool     []*ipamutils.NetworkToSplit
 }
 
 // ClusterCfg represents cluster configuration
@@ -113,7 +113,7 @@ func OptionDefaultDriver(dd string) Option {
 }
 
 // OptionDefaultAddressPoolConfig function returns an option setter for default address pool
-func OptionDefaultAddressPoolConfig(addressPool []*ipamutils.PredefinedPools) Option {
+func OptionDefaultAddressPoolConfig(addressPool []*ipamutils.NetworkToSplit) Option {
 	return func(c *Config) {
 		c.Daemon.DefaultAddressPool = addressPool
 	}

drivers_ipam.go

@@ -9,7 +9,7 @@ import (
 	"github.com/docker/libnetwork/ipamutils"
 )
 
-func initIPAMDrivers(r *drvregistry.DrvRegistry, lDs, gDs interface{}, addressPool []*ipamutils.PredefinedPools) error {
+func initIPAMDrivers(r *drvregistry.DrvRegistry, lDs, gDs interface{}, addressPool []*ipamutils.NetworkToSplit) error {
 	builtinIpam.SetDefaultIPAddressPool(addressPool)
 	for _, fn := range [](func(ipamapi.Callback, interface{}, interface{}) error){
 		builtinIpam.Init,

ipams/builtin/builtin_unix.go

@@ -13,7 +13,7 @@ import (
 
 var (
 	// defaultAddressPool Stores user configured subnet list
-	defaultAddressPool []*ipamutils.PredefinedPools
+	defaultAddressPool []*ipamutils.NetworkToSplit
 )
 
 // Init registers the built-in ipam service with libnetwork
@@ -48,11 +48,11 @@ func Init(ic ipamapi.Callback, l, g interface{}) error {
 }
 
 // SetDefaultIPAddressPool stores default address pool.
-func SetDefaultIPAddressPool(addressPool []*ipamutils.PredefinedPools) {
+func SetDefaultIPAddressPool(addressPool []*ipamutils.NetworkToSplit) {
 	defaultAddressPool = addressPool
 }
 
 // GetDefaultIPAddressPool returns default address pool.
-func GetDefaultIPAddressPool() []*ipamutils.PredefinedPools {
+func GetDefaultIPAddressPool() []*ipamutils.NetworkToSplit {
 	return defaultAddressPool
 }

ipams/builtin/builtin_windows.go

@@ -15,7 +15,7 @@ import (
 
 var (
 	// defaultAddressPool Stores user configured subnet list
-	defaultAddressPool []*ipamutils.PredefinedPools
+	defaultAddressPool []*ipamutils.NetworkToSplit
 )
 
 // InitDockerDefault registers the built-in ipam service with libnetwork
@@ -62,11 +62,11 @@ func Init(ic ipamapi.Callback, l, g interface{}) error {
 }
 
 // SetDefaultIPAddressPool stores default address pool .
-func SetDefaultIPAddressPool(addressPool []*ipamutils.PredefinedPools) {
+func SetDefaultIPAddressPool(addressPool []*ipamutils.NetworkToSplit) {
 	defaultAddressPool = addressPool
 }
 
 // GetDefaultIPAddressPool returns default address pool .
-func GetDefaultIPAddressPool() []*ipamutils.PredefinedPools {
+func GetDefaultIPAddressPool() []*ipamutils.NetworkToSplit {
 	return defaultAddressPool
 }

ipamutils/utils.go

@@ -17,85 +17,57 @@ var (
 	// (10.x.x.x/24) which do not overlap with the networks in `PredefinedBroadNetworks`
 	PredefinedGranularNetworks []*net.IPNet
 	initNetworksOnce           sync.Once
+
+	defaultBroadNetwork = []*NetworkToSplit{{"172.17.0.0/16", 16}, {"172.18.0.0/16", 16}, {"172.19.0.0/16", 16},
+		{"172.20.0.0/14", 16}, {"172.24.0.0/14", 16}, {"172.28.0.0/14", 16},
+		{"192.168.0.0/16", 20}}
+	defaultGranularNetwork = []*NetworkToSplit{{"10.0.0.0/8", 24}}
 )
 
-// PredefinedPools represent a set of address pools with prefix length Size.
-// Each pool in the set is derived from the Base pool. Base is to be passed
-// in CIDR format.Currently we support only local scope networks
+// NetworkToSplit represent a network that has to be split in chunks with mask length Size.
+// Each subnet in the set is derived from the Base pool. Base is to be passed
+// in CIDR format.
 // Example: a Base "10.10.0.0/16 with Size 24 will define the set of 256
 // 10.10.[0-255].0/24 address pools
-type PredefinedPools struct {
+type NetworkToSplit struct {
 	Base string `json:"base"`
 	Size int    `json:"size"`
 }
 
-// InitNetworks initializes the local predefined address pools
-// with the default values.
-func InitNetworks(defaultAddressPool []*PredefinedPools) {
+// InitNetworks initializes the broad network pool and the granular network pool
+func InitNetworks(defaultAddressPool []*NetworkToSplit) {
 	initNetworksOnce.Do(func() {
-		isPredefinedPool := false
-		PredefinedGranularNetworks = initGranularPredefinedNetworks()
+		// error ingnored should never fail
+		PredefinedGranularNetworks, _ = splitNetworks(defaultGranularNetwork)
 		if defaultAddressPool == nil {
-			defaultAddressPool = []*PredefinedPools{{"172.17.0.0/12", 16}, {"192.168.0.0/16", 20}}
-			isPredefinedPool = true
+			defaultAddressPool = defaultBroadNetwork
 		}
-		if err := InitAddressPools(defaultAddressPool); err != nil {
+		var err error
+		if PredefinedBroadNetworks, err = splitNetworks(defaultAddressPool); err != nil {
 			logrus.WithError(err).Error("InitAddressPools failed to initialize the default address pool")
 		}
-		if isPredefinedPool {
-			PredefinedBroadNetworks = append(PredefinedBroadNetworks[:0], PredefinedBroadNetworks[1:]...)
-		}
 	})
 }
-func initBroadPredefinedNetworks() []*net.IPNet {
-	pl := make([]*net.IPNet, 0, 31)
-	mask := []byte{255, 255, 0, 0}
-	for i := 17; i < 32; i++ {
-		pl = append(pl, &net.IPNet{IP: []byte{172, byte(i), 0, 0}, Mask: mask})
-	}
-	mask20 := []byte{255, 255, 240, 0}
-	for i := 0; i < 16; i++ {
-		pl = append(pl, &net.IPNet{IP: []byte{192, 168, byte(i << 4), 0}, Mask: mask20})
-	}
-	return pl
-}
 
-func initGranularPredefinedNetworks() []*net.IPNet {
-	pl := make([]*net.IPNet, 0, 256*256)
-	mask := []byte{255, 255, 255, 0}
-	for i := 0; i < 256; i++ {
-		for j := 0; j < 256; j++ {
-			pl = append(pl, &net.IPNet{IP: []byte{10, byte(i), byte(j), 0}, Mask: mask})
-		}
-	}
-	return pl
-}
-
-// InitAddressPools allows to initialize the local scope predefined
-// address pools to the desired values. It fails is invalid input is passed
-// or if the predefined pools were already initialized.
-func InitAddressPools(list []*PredefinedPools) error {
+// splitNetworks takes a slice of networks, split them accordingly and returns them
+func splitNetworks(list []*NetworkToSplit) ([]*net.IPNet, error) {
 	localPools := make([]*net.IPNet, 0, len(list))
 
 	for _, p := range list {
-		if p == nil {
-			continue
-		}
 		_, b, err := net.ParseCIDR(p.Base)
 		if err != nil {
-			return fmt.Errorf("invalid base pool %q: %v", p.Base, err)
+			return nil, fmt.Errorf("invalid base pool %q: %v", p.Base, err)
 		}
 		ones, _ := b.Mask.Size()
 		if p.Size <= 0 || p.Size < ones {
-			return fmt.Errorf("invalid pools size: %d", p.Size)
+			return nil, fmt.Errorf("invalid pools size: %d", p.Size)
 		}
-		localPools = append(localPools, initPools(p.Size, b)...)
+		localPools = append(localPools, splitNetwork(p.Size, b)...)
 	}
-	PredefinedBroadNetworks = localPools
-	return nil
+	return localPools, nil
 }
 
-func initPools(size int, base *net.IPNet) []*net.IPNet {
+func splitNetwork(size int, base *net.IPNet) []*net.IPNet {
 	one, bits := base.Mask.Size()
 	mask := net.CIDRMask(size, bits)
 	n := 1 << uint(size-one)

ipamutils/utils_test.go

@@ -1,18 +1,40 @@
 package ipamutils
 
 import (
+	"net"
 	"sync"
 	"testing"
 
 	_ "github.com/docker/libnetwork/testutils"
 	"github.com/stretchr/testify/assert"
 )
 
-func init() {
-	InitNetworks(nil)
+func initBroadPredefinedNetworks() []*net.IPNet {
+	pl := make([]*net.IPNet, 0, 31)
+	mask := []byte{255, 255, 0, 0}
+	for i := 17; i < 32; i++ {
+		pl = append(pl, &net.IPNet{IP: []byte{172, byte(i), 0, 0}, Mask: mask})
+	}
+	mask20 := []byte{255, 255, 240, 0}
+	for i := 0; i < 16; i++ {
+		pl = append(pl, &net.IPNet{IP: []byte{192, 168, byte(i << 4), 0}, Mask: mask20})
+	}
+	return pl
 }
 
-func TestGranularPredefined(t *testing.T) {
+func initGranularPredefinedNetworks() []*net.IPNet {
+	pl := make([]*net.IPNet, 0, 256*256)
+	mask := []byte{255, 255, 255, 0}
+	for i := 0; i < 256; i++ {
+		for j := 0; j < 256; j++ {
+			pl = append(pl, &net.IPNet{IP: []byte{10, byte(i), byte(j), 0}, Mask: mask})
+		}
+	}
+	return pl
+}
+
+func TestDefaultNetwork(t *testing.T) {
+	InitNetworks(nil)
 	for _, nw := range PredefinedGranularNetworks {
 		if ones, bits := nw.Mask.Size(); bits != 32 || ones != 24 {
 			t.Fatalf("Unexpected size for network in granular list: %v", nw)
@@ -25,14 +47,37 @@ func TestGranularPredefined(t *testing.T) {
 		}
 	}
 
+	originalBroadNets := initBroadPredefinedNetworks()
+	m := make(map[string]bool)
+	for _, v := range originalBroadNets {
+		m[v.String()] = true
+	}
+	for _, nw := range PredefinedBroadNetworks {
+		_, ok := m[nw.String()]
+		assert.True(t, ok)
+		delete(m, nw.String())
+	}
+
+	assert.Len(t, m, 0)
+
+	originalGranularNets := initGranularPredefinedNetworks()
+
+	m = make(map[string]bool)
+	for _, v := range originalGranularNets {
+		m[v.String()] = true
+	}
+	for _, nw := range PredefinedGranularNetworks {
+		_, ok := m[nw.String()]
+		assert.True(t, ok)
+		delete(m, nw.String())
+	}
+
+	assert.Len(t, m, 0)
 }
 
 func TestInitAddressPools(t *testing.T) {
-	prePool1 := &PredefinedPools{"172.80.0.0/16", 24}
-	prePool2 := &PredefinedPools{"172.90.0.0/16", 24}
-	DefaultAddressPools := []*PredefinedPools{prePool1, prePool2}
 	initNetworksOnce = sync.Once{}
-	InitNetworks(DefaultAddressPools)
+	InitNetworks([]*NetworkToSplit{{"172.80.0.0/16", 24}, {"172.90.0.0/16", 24}})
 
 	// Check for Random IPAddresses in PredefinedBroadNetworks  ex: first , last and middle
 	assert.Len(t, PredefinedBroadNetworks, 512, "Failed to find PredefinedBroadNetworks")