Merge pull request #1183 from k8s-infra-cherrypick-robot/cherry-pick-1180-to-release-1.4

[release-1.4] Improve FastCheck performance

Author: ahrtr

bucket.go

@@ -884,7 +884,9 @@ func (b *Bucket) node(pgId common.Pgid, parent *node) *node {
 		// if p isn't nil, then it's an inline bucket.
 		// The pgId must be 0 in this case.
 		common.Verify(func() {
-			common.Assert(pgId == 0, "The page ID (%d) isn't 0 for an inline bucket", pgId)
+			if pgId != 0 {
+				panic(fmt.Sprintf("assertion failed: The page ID (%d) isn't 0 for an inline bucket", pgId))
+			}
 		})
 	}
 

internal/common/bench_test.go

@@ -0,0 +1,19 @@
+package common_test
+
+import (
+	"math/rand/v2"
+	"testing"
+
+	"go.etcd.io/bbolt/internal/common"
+)
+
+func BenchmarkFastCheck(b *testing.B) {
+	var (
+		id    = common.Pgid(rand.Uint64())                    // Important, constant ID optimizes some code out.
+		flags = uint16(common.BranchPageFlag) << rand.IntN(3) // From 0x01 to 0x04.
+		p     = common.NewPage(id, flags, 0, 0)
+	)
+	for b.Loop() {
+		p.FastCheck(id)
+	}
+}

internal/common/page.go

@@ -74,19 +74,27 @@ func (p *Page) IsFreelistPage() bool {
 	return p.flags == FreelistPageFlag
 }
 
+// IsValidPage checks Page flags correctness, only a single proper flag can be used.
+func (p *Page) IsValidPage() bool {
+	return p.IsBranchPage() ||
+		p.IsLeafPage() ||
+		p.IsMetaPage() ||
+		p.IsFreelistPage()
+}
+
 // Meta returns a pointer to the metadata section of the page.
 func (p *Page) Meta() *Meta {
 	return (*Meta)(UnsafeAdd(unsafe.Pointer(p), unsafe.Sizeof(*p)))
 }
 
 func (p *Page) FastCheck(id Pgid) {
-	Assert(p.id == id, "Page expected to be: %v, but self identifies as %v", id, p.id)
+	if p.id != id {
+		panic(fmt.Sprintf("assertion failed: Page expected to be: %v, but self identifies as %v", id, p.id))
+	}
 	// Only one flag of page-type can be set.
-	Assert(p.IsBranchPage() ||
-		p.IsLeafPage() ||
-		p.IsMetaPage() ||
-		p.IsFreelistPage(),
-		"page %v: has unexpected type/flags: %x", p.id, p.flags)
+	if !p.IsValidPage() {
+		panic(fmt.Sprintf("assertion failed: page %v: has unexpected type/flags: %x", p.id, p.flags))
+	}
 }
 
 // LeafPageElement retrieves the leaf node by index
@@ -122,7 +130,9 @@ func (p *Page) BranchPageElements() []branchPageElement {
 }
 
 func (p *Page) FreelistPageCount() (int, int) {
-	Assert(p.IsFreelistPage(), fmt.Sprintf("can't get freelist page count from a non-freelist page: %2x", p.flags))
+	if !p.IsFreelistPage() {
+		panic(fmt.Sprintf("assertion failed: can't get freelist page count from a non-freelist page: %2x", p.flags))
+	}
 
 	// If the page.count is at the max uint16 value (64k) then it's considered
 	// an overflow and the size of the freelist is stored as the first element.
@@ -140,7 +150,9 @@ func (p *Page) FreelistPageCount() (int, int) {
 }
 
 func (p *Page) FreelistPageIds() []Pgid {
-	Assert(p.IsFreelistPage(), fmt.Sprintf("can't get freelist page IDs from a non-freelist page: %2x", p.flags))
+	if !p.IsFreelistPage() {
+		panic(fmt.Sprintf("assertion failed: can't get freelist page IDs from a non-freelist page: %2x", p.flags))
+	}
 
 	idx, count := p.FreelistPageCount()
 

internal/freelist/hashmap.go

@@ -108,8 +108,10 @@ func (f *hashMap) Allocate(txid common.Txid, n int) common.Pgid {
 func (f *hashMap) FreeCount() int {
 	common.Verify(func() {
 		expectedFreePageCount := f.hashmapFreeCountSlow()
-		common.Assert(int(f.freePagesCount) == expectedFreePageCount,
-			"freePagesCount (%d) is out of sync with free pages map (%d)", f.freePagesCount, expectedFreePageCount)
+		if int(f.freePagesCount) != expectedFreePageCount {
+			panic(fmt.Sprintf("assertion failed: freePagesCount (%d) is out of sync with free pages map (%d)",
+				f.freePagesCount, expectedFreePageCount))
+		}
 	})
 	return int(f.freePagesCount)
 }