aboutsummaryrefslogtreecommitdiff
path: root/src/runtime/checkptr.go
diff options
context:
space:
mode:
authorRuss Cox <rsc@golang.org>2024-05-21 23:24:47 -0400
committerGopher Robot <gobot@golang.org>2024-05-23 00:18:55 +0000
commitbde905af5b11e3e34bc1f5d4846d7767f7197236 (patch)
tree8def6eab2e681e1b463e8327279bc8f833b5f10f /src/runtime/checkptr.go
parent2f07d4455636ece45ff843fe4d9298ea65f933c1 (diff)
downloadgo-bde905af5b11e3e34bc1f5d4846d7767f7197236.tar.xz
all: document legacy //go:linkname for modules with ≥20,000 dependents
For #67401. Change-Id: Icc10ede72547d8020c0ba45e89d954822a4b2455 Reviewed-on: https://go-review.googlesource.com/c/go/+/587218 Auto-Submit: Russ Cox <rsc@golang.org> Reviewed-by: Cherry Mui <cherryyz@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Diffstat (limited to 'src/runtime/checkptr.go')
-rw-r--r--src/runtime/checkptr.go10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/runtime/checkptr.go b/src/runtime/checkptr.go
index 810787bff5..be64ae7f0c 100644
--- a/src/runtime/checkptr.go
+++ b/src/runtime/checkptr.go
@@ -76,6 +76,16 @@ func checkptrArithmetic(p unsafe.Pointer, originals []unsafe.Pointer) {
// checkptrBase(p1) == checkptrBase(p2). However, the converse/inverse
// is not necessarily true as allocations can have trailing padding,
// and multiple variables may be packed into a single allocation.
+//
+// checkptrBase should be an internal detail,
+// but widely used packages access it using linkname.
+// Notable members of the hall of shame include:
+// - github.com/bytedance/sonic
+//
+// Do not remove or change the type signature.
+// See go.dev/issue/67401.
+//
+//go:linkname checkptrBase
func checkptrBase(p unsafe.Pointer) uintptr {
// stack
if gp := getg(); gp.stack.lo <= uintptr(p) && uintptr(p) < gp.stack.hi {