gvisor.dev/gvisor@v0.0.0-20240520182842-f9d4d51c7e0f/pkg/segment/test/segment_test.go

// Copyright 2018 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package segment

import (
	"fmt"
	"math/rand"
	"slices"
	"testing"
)

const (
	// testSize is the baseline number of elements inserted into sets under
	// test, and is chosen to be large enough to ensure interesting amounts of
	// tree rebalancing.
	//
	// Note that because checkSet is called between each insertion/removal in
	// some tests that use it, tests may be quadratic in testSize.
	testSize = 8000

	// valueOffset is the difference between the value and start of test
	// segments.
	valueOffset = 100000

	// intervalLength is the interval used by random gap tests.
	intervalLength = 10
)

func shuffle(xs []int) {
	rand.Shuffle(len(xs), func(i, j int) { xs[i], xs[j] = xs[j], xs[i] })
}

func randIntervalPermutation(size int) []int {
	p := make([]int, size)
	for i := range p {
		p[i] = intervalLength * i
	}
	shuffle(p)
	return p
}

// validate can be passed to Check.
func validate(nr int, r Range, v int) error {
	if got, want := v, r.Start+valueOffset; got != want {
		return fmt.Errorf("segment %d has key %d, value %d (expected %d)", nr, r.Start, got, want)
	}
	return nil
}

// checkSetMaxGap returns an error if maxGap inside all nodes of s is not well
// maintained.
func checkSetMaxGap(s *gapSet) error {
	n := s.root
	return checkNodeMaxGap(&n)
}

// checkNodeMaxGap returns an error if maxGap inside the subtree rooted by n is
// not well maintained.
func checkNodeMaxGap(n *gapnode) error {
	var max int
	if !n.hasChildren {
		max = n.calculateMaxGapLeaf()
	} else {
		for i := 0; i <= n.nrSegments; i++ {
			child := n.children[i]
			if err := checkNodeMaxGap(child); err != nil {
				return err
			}
			if temp := child.maxGap.Get(); i == 0 || temp > max {
				max = temp
			}
		}
	}
	if max != n.maxGap.Get() {
		return fmt.Errorf("maxGap wrong in node\n%vexpected: %d got: %d", n, max, n.maxGap)
	}
	return nil
}

func TestAddRandom(t *testing.T) {
	var s Set
	order := rand.Perm(testSize)
	var nrInsertions int
	for i, j := range order {
		s.InsertWithoutMergingRange(Range{j, j + 1}, j+valueOffset)
		nrInsertions++
		if err := s.segmentTestCheck(nrInsertions, validate); err != nil {
			t.Errorf("Iteration %d: %v", i, err)
			break
		}
	}
	if got, want := s.countSegments(), nrInsertions; got != want {
		t.Errorf("Wrong final number of segments: got %d, wanted %d", got, want)
	}
	if t.Failed() {
		t.Logf("Insertion order: %v", order[:nrInsertions])
		t.Logf("Set contents:\n%v", &s)
	}
}

func TestRemoveRandom(t *testing.T) {
	var s Set
	for i := 0; i < testSize; i++ {
		s.InsertWithoutMergingRange(Range{i, i + 1}, i+valueOffset)
	}
	order := rand.Perm(testSize)
	var nrRemovals int
	for i, j := range order {
		seg := s.FindSegment(j)
		if !seg.Ok() {
			t.Errorf("Iteration %d: failed to find segment with key %d", i, j)
			break
		}
		s.Remove(seg)
		nrRemovals++
		if err := s.segmentTestCheck(testSize-nrRemovals, validate); err != nil {
			t.Errorf("Iteration %d: %v", i, err)
			break
		}
	}
	if got, want := s.countSegments(), testSize-nrRemovals; got != want {
		t.Errorf("Wrong final number of segments: got %d, wanted %d", got, want)
	}
	if t.Failed() {
		t.Logf("Removal order: %v", order[:nrRemovals])
		t.Logf("Set contents:\n%v", &s)
		t.FailNow()
	}
}

func TestMaxGapAddRandom(t *testing.T) {
	var s gapSet
	order := rand.Perm(testSize)
	var nrInsertions int
	for i, j := range order {
		s.InsertWithoutMergingRange(Range{j, j + 1}, j+valueOffset)
		nrInsertions++
		if err := s.segmentTestCheck(nrInsertions, validate); err != nil {
			t.Errorf("Iteration %d: %v", i, err)
			break
		}
		if err := checkSetMaxGap(&s); err != nil {
			t.Errorf("When inserting %d: %v", j, err)
			break
		}
	}
	if got, want := s.countSegments(), nrInsertions; got != want {
		t.Errorf("Wrong final number of segments: got %d, wanted %d", got, want)
	}
	if t.Failed() {
		t.Logf("Insertion order: %v", order[:nrInsertions])
		t.Logf("Set contents:\n%v", &s)
	}
}

func TestMaxGapAddRandomWithRandomInterval(t *testing.T) {
	var s gapSet
	order := randIntervalPermutation(testSize)
	var nrInsertions int
	for i, j := range order {
		s.InsertWithoutMergingRange(Range{j, j + rand.Intn(intervalLength-1) + 1}, j+valueOffset)
		nrInsertions++
		if err := s.segmentTestCheck(nrInsertions, validate); err != nil {
			t.Errorf("Iteration %d: %v", i, err)
			break
		}
		if err := checkSetMaxGap(&s); err != nil {
			t.Errorf("When inserting %d: %v", j, err)
			break
		}
	}
	if got, want := s.countSegments(), nrInsertions; got != want {
		t.Errorf("Wrong final number of segments: got %d, wanted %d", got, want)
	}
	if t.Failed() {
		t.Logf("Insertion order: %v", order[:nrInsertions])
		t.Logf("Set contents:\n%v", &s)
	}
}

func TestMaxGapAddRandomWithMerge(t *testing.T) {
	var s gapSet
	order := randIntervalPermutation(testSize)
	for _, j := range order {
		s.InsertRange(Range{j, j + intervalLength}, 0)
		if err := checkSetMaxGap(&s); err != nil {
			t.Errorf("When inserting %d: %v", j, err)
			break
		}
	}
	if got, want := s.countSegments(), 1; got != want {
		t.Errorf("Wrong final number of segments: got %d, wanted %d", got, want)
	}
	if t.Failed() {
		t.Logf("Insertion order: %v", order)
		t.Logf("Set contents:\n%v", &s)
	}
}

func TestMaxGapRemoveRandom(t *testing.T) {
	var s gapSet
	for i := 0; i < testSize; i++ {
		s.InsertWithoutMergingRange(Range{i, i + 1}, i+valueOffset)
	}
	order := rand.Perm(testSize)
	var nrRemovals int
	for i, j := range order {
		seg := s.FindSegment(j)
		if !seg.Ok() {
			t.Errorf("Iteration %d: failed to find segment with key %d", i, j)
			break
		}
		temprange := seg.Range()
		s.Remove(seg)
		nrRemovals++
		if err := s.segmentTestCheck(testSize-nrRemovals, validate); err != nil {
			t.Errorf("Iteration %d: %v", i, err)
			break
		}
		if err := checkSetMaxGap(&s); err != nil {
			t.Errorf("When removing %v: %v", temprange, err)
			break
		}
	}
	if got, want := s.countSegments(), testSize-nrRemovals; got != want {
		t.Errorf("Wrong final number of segments: got %d, wanted %d", got, want)
	}
	if t.Failed() {
		t.Logf("Removal order: %v", order[:nrRemovals])
		t.Logf("Set contents:\n%v", &s)
		t.FailNow()
	}
}

func TestMaxGapRemoveHalfRandom(t *testing.T) {
	var s gapSet
	for i := 0; i < testSize; i++ {
		s.InsertWithoutMergingRange(Range{intervalLength * i, intervalLength*i + rand.Intn(intervalLength-1) + 1}, intervalLength*i+valueOffset)
	}
	order := randIntervalPermutation(testSize)
	order = order[:testSize/2]
	var nrRemovals int
	for i, j := range order {
		seg := s.FindSegment(j)
		if !seg.Ok() {
			t.Errorf("Iteration %d: failed to find segment with key %d", i, j)
			break
		}
		temprange := seg.Range()
		s.Remove(seg)
		nrRemovals++
		if err := s.segmentTestCheck(testSize-nrRemovals, validate); err != nil {
			t.Errorf("Iteration %d: %v", i, err)
			break
		}
		if err := checkSetMaxGap(&s); err != nil {
			t.Errorf("When removing %v: %v", temprange, err)
			break
		}
	}
	if got, want := s.countSegments(), testSize-nrRemovals; got != want {
		t.Errorf("Wrong final number of segments: got %d, wanted %d", got, want)
	}
	if t.Failed() {
		t.Logf("Removal order: %v", order[:nrRemovals])
		t.Logf("Set contents:\n%v", &s)
		t.FailNow()
	}
}

func TestMaxGapRemoveHalfRandomWithMerge(t *testing.T) {
	var s gapSet
	s.InsertRange(Range{0, intervalLength * testSize}, 0)
	order := randIntervalPermutation(testSize)
	order = order[:testSize/2]
	var nrRemovals int
	for _, j := range order {
		temprange := Range{j, j + intervalLength}
		s.RemoveFullRange(temprange)
		nrRemovals++
		if err := checkSetMaxGap(&s); err != nil {
			t.Errorf("When removing %v: %v", temprange, err)
			break
		}
	}
	if t.Failed() {
		t.Logf("Removal order: %v", order[:nrRemovals])
		t.Logf("Set contents:\n%v", &s)
		t.FailNow()
	}
}

func TestNextLargeEnoughGap(t *testing.T) {
	var s gapSet
	order := randIntervalPermutation(testSize * 2)
	order = order[:testSize]
	for _, j := range order {
		s.InsertRange(Range{j, j + rand.Intn(intervalLength-1) + 1}, j+valueOffset)
		if err := checkSetMaxGap(&s); err != nil {
			t.Errorf("When inserting %d: %v", j, err)
			break
		}
	}
	shuffle(order)
	order = order[:testSize/2]
	for _, j := range order {
		seg := s.FindSegment(j)
		if !seg.Ok() {
			continue
		}
		temprange := seg.Range()
		s.Remove(seg)
		if err := checkSetMaxGap(&s); err != nil {
			t.Errorf("When removing %v: %v", temprange, err)
			break
		}
	}
	minSize := 7
	var gapArr1 []int
	for gap := s.LowerBoundGap(0).NextLargeEnoughGap(minSize); gap.Ok(); gap = gap.NextLargeEnoughGap(minSize) {
		if gap.Range().Length() < minSize {
			t.Errorf("NextLargeEnoughGap wrong, gap %v has length %d, wanted %d", gap.Range(), gap.Range().Length(), minSize)
		} else {
			gapArr1 = append(gapArr1, gap.Range().Start)
		}
	}
	var gapArr2 []int
	for gap := s.LowerBoundGap(0).NextGap(); gap.Ok(); gap = gap.NextGap() {
		if gap.Range().Length() >= minSize {
			gapArr2 = append(gapArr2, gap.Range().Start)
		}
	}

	if !slices.Equal(gapArr2, gapArr1) {
		t.Errorf("Search result not correct, got: %v, wanted: %v", gapArr1, gapArr2)
	}
	if t.Failed() {
		t.Logf("Set contents:\n%v", &s)
		t.FailNow()
	}
}

func TestPrevLargeEnoughGap(t *testing.T) {
	var s gapSet
	order := randIntervalPermutation(testSize * 2)
	order = order[:testSize]
	for _, j := range order {
		s.InsertRange(Range{j, j + rand.Intn(intervalLength-1) + 1}, j+valueOffset)
		if err := checkSetMaxGap(&s); err != nil {
			t.Errorf("When inserting %d: %v", j, err)
			break
		}
	}
	end := s.LastSegment().End()
	shuffle(order)
	order = order[:testSize/2]
	for _, j := range order {
		seg := s.FindSegment(j)
		if !seg.Ok() {
			continue
		}
		temprange := seg.Range()
		s.Remove(seg)
		if err := checkSetMaxGap(&s); err != nil {
			t.Errorf("When removing %v: %v", temprange, err)
			break
		}
	}
	minSize := 7
	var gapArr1 []int
	for gap := s.UpperBoundGap(end + intervalLength).PrevLargeEnoughGap(minSize); gap.Ok(); gap = gap.PrevLargeEnoughGap(minSize) {
		if gap.Range().Length() < minSize {
			t.Errorf("PrevLargeEnoughGap wrong, gap length %d, wanted %d", gap.Range().Length(), minSize)
		} else {
			gapArr1 = append(gapArr1, gap.Range().Start)
		}
	}
	var gapArr2 []int
	for gap := s.UpperBoundGap(end + intervalLength).PrevGap(); gap.Ok(); gap = gap.PrevGap() {
		if gap.Range().Length() >= minSize {
			gapArr2 = append(gapArr2, gap.Range().Start)
		}
	}
	if !slices.Equal(gapArr2, gapArr1) {
		t.Errorf("Search result not correct, got: %v, wanted: %v", gapArr1, gapArr2)
	}
	if t.Failed() {
		t.Logf("Set contents:\n%v", &s)
		t.FailNow()
	}
}

func TestAddSequentialAdjacent(t *testing.T) {
	var s Set
	var nrInsertions int
	for i := 0; i < testSize; i++ {
		s.InsertWithoutMergingRange(Range{i, i + 1}, i+valueOffset)
		nrInsertions++
		if err := s.segmentTestCheck(nrInsertions, validate); err != nil {
			t.Errorf("Iteration %d: %v", i, err)
			break
		}
	}
	if got, want := s.countSegments(), nrInsertions; got != want {
		t.Errorf("Wrong final number of segments: got %d, wanted %d", got, want)
	}
	if t.Failed() {
		t.Logf("Set contents:\n%v", &s)
	}

	first := s.FirstSegment()
	gotSeg, gotGap := first.PrevNonEmpty()
	if wantGap := s.FirstGap(); gotSeg.Ok() || gotGap != wantGap {
		t.Errorf("FirstSegment().PrevNonEmpty(): got (%v, %v), wanted (<terminal iterator>, %v)", gotSeg, gotGap, wantGap)
	}
	gotSeg, gotGap = first.NextNonEmpty()
	if wantSeg := first.NextSegment(); gotSeg != wantSeg || gotGap.Ok() {
		t.Errorf("FirstSegment().NextNonEmpty(): got (%v, %v), wanted (%v, <terminal iterator>)", gotSeg, gotGap, wantSeg)
	}

	last := s.LastSegment()
	gotSeg, gotGap = last.PrevNonEmpty()
	if wantSeg := last.PrevSegment(); gotSeg != wantSeg || gotGap.Ok() {
		t.Errorf("LastSegment().PrevNonEmpty(): got (%v, %v), wanted (%v, <terminal iterator>)", gotSeg, gotGap, wantSeg)
	}
	gotSeg, gotGap = last.NextNonEmpty()
	if wantGap := s.LastGap(); gotSeg.Ok() || gotGap != wantGap {
		t.Errorf("LastSegment().NextNonEmpty(): got (%v, %v), wanted (<terminal iterator>, %v)", gotSeg, gotGap, wantGap)
	}

	for seg := first.NextSegment(); seg != last; seg = seg.NextSegment() {
		gotSeg, gotGap = seg.PrevNonEmpty()
		if wantSeg := seg.PrevSegment(); gotSeg != wantSeg || gotGap.Ok() {
			t.Errorf("%v.PrevNonEmpty(): got (%v, %v), wanted (%v, <terminal iterator>)", seg, gotSeg, gotGap, wantSeg)
		}
		gotSeg, gotGap = seg.NextNonEmpty()
		if wantSeg := seg.NextSegment(); gotSeg != wantSeg || gotGap.Ok() {
			t.Errorf("%v.NextNonEmpty(): got (%v, %v), wanted (%v, <terminal iterator>)", seg, gotSeg, gotGap, wantSeg)
		}
	}
}

func TestAddSequentialNonAdjacent(t *testing.T) {
	var s Set
	var nrInsertions int
	for i := 0; i < testSize; i++ {
		// The range here differs from TestAddSequentialAdjacent so that
		// consecutive segments are not adjacent.
		s.InsertWithoutMergingRange(Range{2 * i, 2*i + 1}, 2*i+valueOffset)
		nrInsertions++
		if err := s.segmentTestCheck(nrInsertions, validate); err != nil {
			t.Errorf("Iteration %d: %v", i, err)
			break
		}
	}
	if got, want := s.countSegments(), nrInsertions; got != want {
		t.Errorf("Wrong final number of segments: got %d, wanted %d", got, want)
	}
	if t.Failed() {
		t.Logf("Set contents:\n%v", &s)
	}

	for seg := s.FirstSegment(); seg.Ok(); seg = seg.NextSegment() {
		gotSeg, gotGap := seg.PrevNonEmpty()
		if wantGap := seg.PrevGap(); gotSeg.Ok() || gotGap != wantGap {
			t.Errorf("%v.PrevNonEmpty(): got (%v, %v), wanted (<terminal iterator>, %v)", seg, gotSeg, gotGap, wantGap)
		}
		gotSeg, gotGap = seg.NextNonEmpty()
		if wantGap := seg.NextGap(); gotSeg.Ok() || gotGap != wantGap {
			t.Errorf("%v.NextNonEmpty(): got (%v, %v), wanted (<terminal iterator>, %v)", seg, gotSeg, gotGap, wantGap)
		}
	}
}

func TestMerge(t *testing.T) {
	tests := []struct {
		name      string
		initial   []Range
		split     bool
		splitAddr int
		final     []Range
	}{
		{
			name:    "InsertRange merges after existing segment",
			initial: []Range{{1000, 1100}, {1100, 1200}},
			final:   []Range{{1000, 1200}},
		},
		{
			name:    "InsertRange merges before existing segment",
			initial: []Range{{1100, 1200}, {1000, 1100}},
			final:   []Range{{1000, 1200}},
		},
		{
			name:    "InsertRange merges between existing segments",
			initial: []Range{{1000, 1100}, {1200, 1300}, {1100, 1200}},
			final:   []Range{{1000, 1300}},
		},
	}
Tests:
	for _, test := range tests {
		var s Set
		for _, r := range test.initial {
			s.InsertRange(r, 0)
		}
		var i int
		for seg := s.FirstSegment(); seg.Ok(); seg = seg.NextSegment() {
			if i > len(test.final) {
				t.Errorf("%s: Incorrect number of segments: got %d, wanted %d; set contents:\n%v", test.name, s.countSegments(), len(test.final), &s)
				continue Tests
			}
			if got, want := seg.Range(), test.final[i]; got != want {
				t.Errorf("%s: Segment %d mismatch: got %v, wanted %v; set contents:\n%v", test.name, i, got, want, &s)
				continue Tests
			}
			i++
		}
		if i < len(test.final) {
			t.Errorf("%s: Incorrect number of segments: got %d, wanted %d; set contents:\n%v", test.name, i, len(test.final), &s)
		}
	}
}

func TestIsolate(t *testing.T) {
	tests := []struct {
		name    string
		initial Range
		bounds  Range
		final   []Range
	}{
		{
			name:    "Isolate does not split a segment that falls inside bounds",
			initial: Range{100, 200},
			bounds:  Range{100, 200},
			final:   []Range{{100, 200}},
		},
		{
			name:    "Isolate splits at beginning of segment",
			initial: Range{50, 200},
			bounds:  Range{100, 200},
			final:   []Range{{50, 100}, {100, 200}},
		},
		{
			name:    "Isolate splits at end of segment",
			initial: Range{100, 250},
			bounds:  Range{100, 200},
			final:   []Range{{100, 200}, {200, 250}},
		},
		{
			name:    "Isolate splits at beginning and end of segment",
			initial: Range{50, 250},
			bounds:  Range{100, 200},
			final:   []Range{{50, 100}, {100, 200}, {200, 250}},
		},
	}
Tests:
	for _, test := range tests {
		var s Set
		seg := s.Insert(s.FirstGap(), test.initial, 0)
		seg = s.Isolate(seg, test.bounds)
		if !test.bounds.IsSupersetOf(seg.Range()) {
			t.Errorf("%s: Isolated segment %v lies outside bounds %v; set contents:\n%v", test.name, seg.Range(), test.bounds, &s)
		}
		var i int
		for seg := s.FirstSegment(); seg.Ok(); seg = seg.NextSegment() {
			if i > len(test.final) {
				t.Errorf("%s: Incorrect number of segments: got %d, wanted %d; set contents:\n%v", test.name, s.countSegments(), len(test.final), &s)
				continue Tests
			}
			if got, want := seg.Range(), test.final[i]; got != want {
				t.Errorf("%s: Segment %d mismatch: got %v, wanted %v; set contents:\n%v", test.name, i, got, want, &s)
				continue Tests
			}
			i++
		}
		if i < len(test.final) {
			t.Errorf("%s: Incorrect number of segments: got %d, wanted %d; set contents:\n%v", test.name, i, len(test.final), &s)
		}
	}
}

func TestMutateRange(t *testing.T) {
	tests := []struct {
		name      string
		initial   []FlatSegment
		increment Range
		final     []FlatSegment
	}{
		{
			name:      "MutateRange no-op in empty set",
			increment: Range{100, 200},
		},
		{
			name: "MutateRange modifies existing segment",
			initial: []FlatSegment{
				{100, 200, 0},
			},
			increment: Range{100, 200},
			final: []FlatSegment{
				{100, 200, 1},
			},
		},
		{
			name: "MutateRange splits segments",
			initial: []FlatSegment{
				{50, 150, 0},
				{150, 250, 2},
			},
			increment: Range{100, 200},
			final: []FlatSegment{
				{50, 100, 0},
				{100, 150, 1},
				{150, 200, 3},
				{200, 250, 2},
			},
		},
		{
			name: "MutateRange merges compatible segments",
			initial: []FlatSegment{
				{0, 100, 1},
				{100, 200, 0},
				{200, 300, 1},
			},
			increment: Range{100, 200},
			final: []FlatSegment{
				{0, 300, 1},
			},
		},
	}
	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			var s Set
			if err := s.ImportSlice(test.initial); err != nil {
				t.Fatalf("Failed to import initial set: %v", err)
			}
			s.MutateRange(test.increment, func(seg Iterator) bool {
				(*seg.ValuePtr())++
				return true
			})
			if got := s.ExportSlice(); !slices.Equal(got, test.final) {
				t.Errorf("Set mismatch after mutation: got %v, wanted %v", got, test.final)
			}
		})
	}
}

func benchmarkAddSequential(b *testing.B, size int) {
	for n := 0; n < b.N; n++ {
		var s Set
		for i := 0; i < size; i++ {
			s.InsertWithoutMergingRange(Range{i, i + 1}, i)
		}
	}
}

func benchmarkAddRandom(b *testing.B, size int) {
	order := rand.Perm(size)

	b.ResetTimer()
	for n := 0; n < b.N; n++ {
		var s Set
		for _, i := range order {
			s.InsertWithoutMergingRange(Range{i, i + 1}, i)
		}
	}
}

func benchmarkFindSequential(b *testing.B, size int) {
	var s Set
	for i := 0; i < size; i++ {
		s.InsertWithoutMergingRange(Range{i, i + 1}, i)
	}

	b.ResetTimer()
	for n := 0; n < b.N; n++ {
		for i := 0; i < size; i++ {
			if seg := s.FindSegment(i); !seg.Ok() {
				b.Fatalf("Failed to find segment %d", i)
			}
		}
	}
}

func benchmarkFindRandom(b *testing.B, size int) {
	var s Set
	for i := 0; i < size; i++ {
		s.InsertWithoutMergingRange(Range{i, i + 1}, i)
	}
	order := rand.Perm(size)

	b.ResetTimer()
	for n := 0; n < b.N; n++ {
		for _, i := range order {
			if si := s.FindSegment(i); !si.Ok() {
				b.Fatalf("Failed to find segment %d", i)
			}
		}
	}
}

func benchmarkIteration(b *testing.B, size int) {
	var s Set
	for i := 0; i < size; i++ {
		s.InsertWithoutMergingRange(Range{i, i + 1}, i)
	}

	b.ResetTimer()
	var count uint64
	for n := 0; n < b.N; n++ {
		for seg := s.FirstSegment(); seg.Ok(); seg = seg.NextSegment() {
			count++
		}
	}
	if got, want := count, uint64(size)*uint64(b.N); got != want {
		b.Fatalf("Iterated wrong number of segments: got %d, wanted %d", got, want)
	}
}

func benchmarkAddFindRemoveSequential(b *testing.B, size int) {
	for n := 0; n < b.N; n++ {
		var s Set
		for i := 0; i < size; i++ {
			s.InsertWithoutMergingRange(Range{i, i + 1}, i)
		}
		for i := 0; i < size; i++ {
			seg := s.FindSegment(i)
			if !seg.Ok() {
				b.Fatalf("Failed to find segment %d", i)
			}
			s.Remove(seg)
		}
		if !s.IsEmpty() {
			b.Fatalf("Set not empty after all removals:\n%v", &s)
		}
	}
}

func benchmarkAddFindRemoveRandom(b *testing.B, size int) {
	order := rand.Perm(size)

	b.ResetTimer()
	for n := 0; n < b.N; n++ {
		var s Set
		for _, i := range order {
			s.InsertWithoutMergingRange(Range{i, i + 1}, i)
		}
		for _, i := range order {
			seg := s.FindSegment(i)
			if !seg.Ok() {
				b.Fatalf("Failed to find segment %d", i)
			}
			s.Remove(seg)
		}
		if !s.IsEmpty() {
			b.Fatalf("Set not empty after all removals:\n%v", &s)
		}
	}
}

// Although we don't generally expect our segment sets to get this big, they're
// useful for emulating the effect of cache pressure.
var testSizes = []struct {
	desc string
	size int
}{
	{"64", 1 << 6},
	{"256", 1 << 8},
	{"1K", 1 << 10},
	{"4K", 1 << 12},
	{"16K", 1 << 14},
	{"64K", 1 << 16},
}

func BenchmarkAddSequential(b *testing.B) {
	for _, test := range testSizes {
		b.Run(test.desc, func(b *testing.B) {
			benchmarkAddSequential(b, test.size)
		})
	}
}

func BenchmarkAddRandom(b *testing.B) {
	for _, test := range testSizes {
		b.Run(test.desc, func(b *testing.B) {
			benchmarkAddRandom(b, test.size)
		})
	}
}

func BenchmarkFindSequential(b *testing.B) {
	for _, test := range testSizes {
		b.Run(test.desc, func(b *testing.B) {
			benchmarkFindSequential(b, test.size)
		})
	}
}

func BenchmarkFindRandom(b *testing.B) {
	for _, test := range testSizes {
		b.Run(test.desc, func(b *testing.B) {
			benchmarkFindRandom(b, test.size)
		})
	}
}

func BenchmarkIteration(b *testing.B) {
	for _, test := range testSizes {
		b.Run(test.desc, func(b *testing.B) {
			benchmarkIteration(b, test.size)
		})
	}
}

func BenchmarkAddFindRemoveSequential(b *testing.B) {
	for _, test := range testSizes {
		b.Run(test.desc, func(b *testing.B) {
			benchmarkAddFindRemoveSequential(b, test.size)
		})
	}
}

func BenchmarkAddFindRemoveRandom(b *testing.B) {
	for _, test := range testSizes {
		b.Run(test.desc, func(b *testing.B) {
			benchmarkAddFindRemoveRandom(b, test.size)
		})
	}
}