package addrset
import (
"encoding/binary"
"fmt"
"math/big"
"net/netip"
"testing"
"gotest.tools/v3/assert"
is "gotest.tools/v3/assert/cmp"
)
func TestIPv4Pool(t *testing.T) {
var (
// It shouldn't matter that host bits are set in the pool Prefix.
subnet = netip.MustParsePrefix("10.20.30.40/16")
as = New(subnet)
addr netip.Addr
err error
)
assert.Check(t, is.Len(as.bitmaps, 0))
assert.Check(t, uint128Equal(as.Len())(0, 0))
// Add the first and last addresses in the range.
// Expect a single bitmap of 65536 bits, with two bits set.
err = as.Add(netip.MustParseAddr("10.20.0.0"))
assert.Assert(t, err)
err = as.Add(netip.MustParseAddr("10.20.255.255"))
assert.Assert(t, err)
assert.Check(t, is.Len(as.bitmaps, 1))
bm := as.bitmaps[subnet.Masked()]
assert.Check(t, is.Equal(bm.Bits(), uint64(65536)))
assert.Check(t, is.Equal(bm.Unselected(), uint64(65534)))
assert.Check(t, uint128Equal(as.Len())(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("0.0.0.0/1")))(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("128.0.0.0/1")))(0, 0))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.0.0.0/8")))(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(subnet))(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.0.0/24")))(0, 1))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.1.0/24")))(0, 0))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.255.0/24")))(0, 1))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.21.0.0/24")))(0, 0))
// Add an address that's already present. Expect an error.
err = as.Add(netip.MustParseAddr("10.20.255.255"))
assert.Check(t, is.ErrorIs(err, ErrAllocated))
// Remove an address that isn't in the set. Expect no error.
err = as.Remove(netip.MustParseAddr("10.20.30.40"))
assert.Check(t, err)
assert.Check(t, uint128Equal(as.Len())(0, 2))
// Remove all addresses, expect to end up with no bitmap.
err = as.Remove(netip.MustParseAddr("10.20.0.0"))
assert.Check(t, err)
err = as.Remove(netip.MustParseAddr("10.20.255.255"))
assert.Check(t, err)
assert.Check(t, is.Len(as.bitmaps, 0))
assert.Check(t, uint128Equal(as.Len())(0, 0))
// Remove an address that isn't in the set (now there's no bitmap). Expect no error.
err = as.Remove(netip.MustParseAddr("10.20.30.40"))
assert.Check(t, err)
// Add any two addresses to the set, with serial=true. Expect the first two addresses.
addr, err = as.AddAny(true)
assert.Check(t, err)
assert.Check(t, is.Equal(addr, netip.MustParseAddr("10.20.0.0")))
addr, err = as.AddAny(true)
assert.Check(t, err)
assert.Check(t, is.Equal(addr, netip.MustParseAddr("10.20.0.1")))
assert.Check(t, uint128Equal(as.Len())(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(subnet))(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.0.0/24")))(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.1.0/24")))(0, 0))
// Add any address in a range. It shouldn't matter that host bits are set in the
// range. Expect the first address in that range.
addr, err = as.AddAnyInRange(netip.MustParsePrefix("10.20.30.40/24"), true)
assert.Check(t, err)
assert.Check(t, is.Equal(addr, netip.MustParseAddr("10.20.30.0")))
assert.Check(t, uint128Equal(as.Len())(0, 3))
assert.Check(t, uint128Equal(as.AddrsInPrefix(subnet))(0, 3))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.0.0/24")))(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.1.0/24")))(0, 0))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.30.0/24")))(0, 1))
}
func TestIPv6Pool(t *testing.T) {
var (
subnet = netip.MustParsePrefix("fddd::dddd/56")
as = New(subnet)
addr netip.Addr
err error
)
assert.Check(t, is.Len(as.bitmaps, 0))
// Add the first and last addresses in the range.
// Expect two bitmaps of 1<<maxBitsPerBitmap bits, with one bit set in each.
err = as.Add(netip.MustParseAddr("fddd::"))
assert.Assert(t, err)
err = as.Add(netip.MustParseAddr("fddd::ff:ffff:ffff:ffff:ffff"))
assert.Assert(t, err)
assert.Check(t, is.Len(as.bitmaps, 2))
for _, bm := range as.bitmaps {
assert.Check(t, is.Equal(bm.Bits(), uint64(1)<<maxBitsPerBitmap))
assert.Check(t, is.Equal(bm.Unselected(), (uint64(1)<<maxBitsPerBitmap)-1))
}
assert.Check(t, uint128Equal(as.Len())(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(subnet))(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("::/1")))(0, 0))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("f000::/1")))(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fddd::/56")))(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fddd::/72")))(0, 1))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fddd::ff:fe00:0000:0000:0000/72")))(0, 0))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fddd::ff:ff00:0000:0000:0000/72")))(0, 1))
// Add an address that's already present in the "upper" bitmap. Expect an error.
err = as.Add(netip.MustParseAddr("fddd::ff:ffff:ffff:ffff:ffff"))
assert.Check(t, is.ErrorIs(err, ErrAllocated))
// Remove an address that isn't in the set. Expect no error.
err = as.Remove(netip.MustParseAddr("fddd::f:0:0:0:0"))
assert.Check(t, err)
// Remove all addresses, expect to end up with no bitmap.
err = as.Remove(netip.MustParseAddr("fddd::"))
assert.Check(t, err)
err = as.Remove(netip.MustParseAddr("fddd::ff:ffff:ffff:ffff:ffff"))
assert.Check(t, err)
assert.Check(t, is.Len(as.bitmaps, 0))
// Remove an address that isn't in the set (now there's no bitmap). Expect no error.
err = as.Remove(netip.MustParseAddr("fddd::f:0:0:0:0"))
assert.Check(t, err)
// Add any two addresses to the set, with serial=true. Expect the first two addresses.
addr, err = as.AddAny(true)
assert.Check(t, err)
assert.Check(t, is.Equal(addr, netip.MustParseAddr("fddd::0")))
addr, err = as.AddAny(true)
assert.Check(t, err)
assert.Check(t, is.Equal(addr, netip.MustParseAddr("fddd::1")))
// Add any address in a range, somewhere in the middle of the pool. Expect the first address in that range.
addr, err = as.AddAnyInRange(netip.MustParsePrefix("fddd:0:0:f0::/60"), true)
assert.Check(t, err)
assert.Check(t, is.Equal(addr, netip.MustParseAddr("fddd:0:0:f0::")))
assert.Check(t, uint128Equal(as.Len())(0, 3))
assert.Check(t, uint128Equal(as.AddrsInPrefix(subnet))(0, 3))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("::/1")))(0, 0))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("f000::/1")))(0, 3))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fddd::/56")))(0, 3))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fddd::/72")))(0, 2))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fddd:0:0:f0::/60")))(0, 1))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fddd:0:0:80::/57")))(0, 1))
}
func Test64BitIPv6Range(t *testing.T) {
as := New(netip.MustParsePrefix("fd75:7f12:d221:7b32::/64"))
addr := netip.MustParseAddr("fd75:7f12:d221:7b32:94b0:97ff:fefe:52da")
err := as.Add(addr)
assert.Check(t, err)
assert.Check(t, uint128Equal(as.Len())(0, 1))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fd75::/16")))(0, 1))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fd75:7f12:d221::/48")))(0, 1))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fd75:7f12:d221:7b32::/64")))(0, 1))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fd75:7f12:d221:7b32::/65")))(0, 0))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("fd75:7f12:d221:7b32:8000::/65")))(0, 1))
err = as.Add(addr)
assert.Check(t, is.ErrorIs(err, ErrAllocated))
assert.Check(t, is.Error(err, "setting bit 1490858602410169050 for fd75:7f12:d221:7b32:94b0:97ff:fefe:52da in pool 'fd75:7f12:d221:7b32::/64': address already allocated"))
err = as.Remove(addr)
assert.Check(t, err)
err = as.Add(addr)
assert.Check(t, err)
}
func Test32BitIPv6Range(t *testing.T) {
as := New(netip.MustParsePrefix("fd75:7f12:d221:7b32::/96"))
addr := netip.MustParseAddr("fd75:7f12:d221:7b32::fefe:52da")
err := as.Add(addr)
assert.Check(t, err)
err = as.Add(addr)
assert.Check(t, is.ErrorIs(err, ErrAllocated))
assert.Check(t, is.Error(err, "setting bit 4278080218 for fd75:7f12:d221:7b32::fefe:52da in pool 'fd75:7f12:d221:7b32::/96': address already allocated"))
err = as.Remove(addr)
assert.Check(t, err)
err = as.Add(addr)
assert.Check(t, err)
}
func TestFullPool(t *testing.T) {
var (
subnet = netip.MustParsePrefix("10.20.30.0/24")
as = New(subnet)
err error
)
for range 256 {
_, err = as.AddAny(true)
assert.Check(t, err)
}
_, err = as.AddAny(true)
assert.Check(t, is.ErrorIs(err, ErrNotAvailable))
assert.Check(t, is.Error(err, "add-any to '10.20.30.0': address not available"))
assert.Check(t, uint128Equal(as.Len())(0, 256))
assert.Check(t, uint128Equal(as.AddrsInPrefix(subnet))(0, 256))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.30.0/23")))(0, 256))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.32.0/23")))(0, 0))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.30.0/25")))(0, 128))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.30.128/25")))(0, 128))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.30.127/25")))(0, 128))
assert.Check(t, uint128Equal(as.AddrsInPrefix(netip.MustParsePrefix("10.20.30.0/26")))(0, 64))
}
func TestNotInPool(t *testing.T) {
var (
subnet = netip.MustParsePrefix("10.20.30.40/16")
as = New(subnet)
addr netip.Addr
err error
)
// Address not in pool.
err = as.Add(netip.MustParseAddr("10.21.0.0"))
assert.Check(t, is.Error(err, "cannot add 10.21.0.0 to '10.20.0.0/16'"))
// Range bigger than pool.
addr, err = as.AddAnyInRange(netip.MustParsePrefix("10.20.0.0/15"), true)
assert.Check(t, is.Error(err, "add-any, range '10.20.0.0/15' is not in subnet '10.20.0.0/16'"))
assert.Check(t, is.Equal(addr, netip.Addr{}))
// Range outside pool.
addr, err = as.AddAnyInRange(netip.MustParsePrefix("10.21.0.0/24"), true)
assert.Check(t, is.Error(err, "add-any, range '10.21.0.0/24' is not in subnet '10.20.0.0/16'"))
assert.Check(t, is.Equal(addr, netip.Addr{}))
}
func TestInvalidPool(t *testing.T) {
var (
as = New(netip.Prefix{})
addr netip.Addr
err error
)
err = as.Add(netip.IPv6Loopback())
assert.Check(t, is.Error(err, "cannot add ::1 to 'invalid Prefix'"))
addr, err = as.AddAny(false)
assert.Check(t, is.Error(err, "no bitmap to add-any to 'invalid IP': negative Prefix bits"))
assert.Check(t, is.Equal(addr, netip.Addr{}))
addr, err = as.AddAnyInRange(netip.Prefix{}, false)
assert.Check(t, is.Error(err, "add-any, range 'invalid Prefix' is not in subnet 'invalid Prefix'"))
assert.Check(t, is.Equal(addr, netip.Addr{}))
addr, err = as.AddAnyInRange(netip.MustParsePrefix("10.20.30.0/24"), false)
assert.Check(t, is.Error(err, "add-any, range '10.20.30.0/24' is not in subnet 'invalid Prefix'"))
assert.Check(t, is.Equal(addr, netip.Addr{}))
err = as.Remove(netip.MustParseAddr("10.20.30.0"))
assert.Check(t, is.Error(err, "10.20.30.0 cannot be removed from 'invalid Prefix'"))
}
func Test64BitPlusAllocation(t *testing.T) {
var (
subnet = netip.MustParsePrefix("fd00::/8")
as = New(subnet)
)
// Without a bitmap method to set all bits in a range in one shot,
// synthesizing a full bitmap by hand-crafting its binary serialization
// and manipulating the AddrSet internals is the most efficient way to
// construct an AddrSet with a large number of bits set.
var fullBitmap []byte
fullBitmap = binary.BigEndian.AppendUint64(fullBitmap, 1<<63) // Header: bits
fullBitmap = binary.BigEndian.AppendUint64(fullBitmap, 0) // Header: unselected
fullBitmap = binary.BigEndian.AppendUint32(fullBitmap, ^uint32(0)) // Sequence: block
fullBitmap = binary.BigEndian.AppendUint64(fullBitmap, 1<<58) // Sequence: count
// Add two addresses 2^63 apart, which requires two bitmaps to represent.
as.Add(netip.MustParseAddr("fd00::"))
as.Add(netip.MustParseAddr("fd00::8000:0000:0000:0000"))
// Set all bits in both bitmaps to all-ones.
for _, bm := range as.bitmaps {
bits := bm.Bits()
assert.Assert(t, bm.UnmarshalBinary(fullBitmap))
assert.Assert(t, is.Equal(bm.Bits(), bits),
"test corrupted the AddrSet while setting up preconditions: unmarshaling synthetic all-ones bitmap changed its size")
}
// 2^64 addresses are in the set, which cannot be represented in a uint64.
assert.Check(t, uint128Equal(as.Len())(1, 0))
assert.Check(t, as.Remove(netip.MustParseAddr("fd00::ffff")))
assert.Check(t, uint128Equal(as.Len())(0, ^uint64(0)))
as.Add(netip.MustParseAddr("fd00:3::1"))
as.Add(netip.MustParseAddr("fd00:4::42"))
assert.Check(t, uint128Equal(as.Len())(1, 1))
}
func uint128Equal(xhi, xlo uint64) func(hi, lo uint64) is.Comparison {
return func(yhi, ylo uint64) is.Comparison {
return func() is.Result {
if xhi == yhi && xlo == ylo {
return is.ResultSuccess
}
x := big.NewInt(0).Or(
big.NewInt(0).Lsh(big.NewInt(0).SetUint64(xhi), 64),
big.NewInt(0).SetUint64(xlo),
)
y := big.NewInt(0).Or(
big.NewInt(0).Lsh(big.NewInt(0).SetUint64(yhi), 64),
big.NewInt(0).SetUint64(ylo),
)
return is.ResultFailure(fmt.Sprintf("%v (%v %v) != %v (%v %v)", x, xhi, xlo, y, yhi, ylo))
}
}
}