internal/sync: warn about incorrect unsafe usage in HashTrieMap

When the HashTrieMap expand method runs out of bits, it can be because
the user mutated a key after insertion using unsafe or similar
in violation of the HashTrieMap invariants.

Adjust the panic message to help triage and debugging by
more directly suggesting unsafe code might be at fault.

CL 694635 is a follow-up change that attempts to detect and
report illegally mutated keys sooner and more precisely.

Updates #74948
Updates #73427

Change-Id: Ib2bca067f0e212b8765c61183f59ac229513a823
Reviewed-on: https://go-review.googlesource.com/c/go/+/694376
Reviewed-by: Michael Knyszek <mknyszek@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>

diff --git a/src/internal/sync/hashtriemap.go b/src/internal/sync/hashtriemap.go
index dbf4c3473ed6a236982d5b94d98b76edb608fdeb..db832974278f1635fb1491c5bc75bff34cf911e2 100644 (file)
--- a/src/internal/sync/hashtriemap.go
+++ b/src/internal/sync/hashtriemap.go
@@ -178,7 +178,7 @@ func (ht *HashTrieMap[K, V]) expand(oldEntry, newEntry *entry[K, V], newHash uin
        top := newIndirect
        for {
                if hashShift == 0 {
-                       panic("internal/sync.HashTrieMap: ran out of hash bits while inserting")
+                       panic("internal/sync.HashTrieMap: ran out of hash bits while inserting (incorrect use of unsafe or cgo, or data race?)")
                }
                hashShift -= nChildrenLog2 // hashShift is for the level parent is at. We need to go deeper.
                oi := (oldHash >> hashShift) & nChildrenMask